• Native OpenStack API

noa
  1. Help Center
  2. Native OpenStack API
  3. API Reference
  4. Nova
  5. ECS Group Management
  6. Querying Details About an ECS Group

Querying Details About an ECS Group

Function

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

URI

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

Table 1 describes the parameters in the URI.
Table 1 Parameter description

Parameter

Mandatory

Description

project_id

Yes

Specifies the project ID.

server_group_id

Yes

Specifies the ECS group UUID.

Response

Response parameters

Table 2 describes the response parameters.

Table 2 Response parameters

Parameter

Type

Description

server_group

Dict

Specifies the ECS group information.

Table 3 server_group parameters

Parameter

Type

Description

id

String

Specifies the ECS group UUID.

name

String

Specifies the ECS group name.

policies

List(String)

Specifies the ECS group type.

members

List(String)

Specifies the ECSs in an ECS group.

metadata

Dict

Specifies the ECS group metadata.

project_id

String

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

user_id

String

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

Examples

  • Example request
    GET /v2/9c53a566cb3443ab910cf0daebca90c4/os-server-groups/5bbcc3c4-1da2-4437-a48a-66f15b1b13f9
    GET /v2.1/9c53a566cb3443ab910cf0daebca90c4/os-server-groups/5bbcc3c4-1da2-4437-a48a-66f15b1b13f9
  • Example response
    {
        "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.