• Native OpenStack API

noa
  1. Help Center
  2. Native OpenStack API
  3. API Reference
  4. Nova
  5. Server Groups
  6. Querying ECS Group Details

Querying ECS Group Details

Function Description

This interface is used to query details about an ECS group.

URI

  • URI format

    GET /v2/{tenant_id}/os-server-groups/{server_group_id}

    GET /v2.1/{tenant_id}/os-server-groups/{server_group_id}

  • Parameter description

    Parameter

    Mandatory

    Description

    tenant_id

    Yes

    Specifies the tenant or project ID.

    server_group_id

    Yes

    Specifies the ECS group UUID.

Response

Parameter

Type

Mandatory

Description

server_group

Dict

Yes

Specifies the ECS group information.

Table 1 server_group parameter information

Parameter

Type

Mandatory

Description

id

String

Yes

Specifies the ECS group UUID.

name

String

Yes

Specifies the ECS group name.

policies

List(String)

Yes

Specifies the ECS group type.

members

List(String)

Yes

Specifies the ECSs in an ECS group.

metadata

Dict

Yes

Specifies the ECS group metadata.

project_id

String

Yes

Specifies the tenant ID in UUID format for the ECS group.

user_id

String

Yes

Specifies the user ID in UUID format for the ECS group.

Request Example

GET /v2/9c53a566cb3443ab910cf0daebca90c4/os-server-groups/5bbcc3c4-1da2-4437-a48a-66f15b1b13f9

GET /v2.1/9c53a566cb3443ab910cf0daebca90c4/os-server-groups/5bbcc3c4-1da2-4437-a48a-66f15b1b13f9

Response Example

{
    "server_group": {
        "id": "5bbcc3c4-1da2-4437-a48a-66f15b1b13f9",
        "name": "test",
        "policies": ["anti-affinity"],
        "members": [],
        "metadata": {},
        "project_id": "9c53a566cb3443ab910cf0daebca90c4"
    }
}

Returned Values

See General Request Returned Values.