Obtaining the Instance Group Information

Function

Obtain DDM instance group information.

Constraints

None

URI

URL format
GET /v3/{project_id}/instances/{instance_id}/groups?offset={offset}&limit={limit}

Parameter description

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID of a tenant in a region To obtain this value, see Obtaining a Project ID.
instance_id	Yes	String	DDM instance ID

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Index offset. The query starts from the next piece of data indexed by this parameter. The value is 0 by default. The value must be a non-negative number.
limit	No	Integer	Maximum records to be queried. Value range: 1 to 128. If the parameter value is not specified, 10 records are obtained by default.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. You can obtain the token by calling the IAM API used to obtain a user token.

Example Request

GET https://{endpoint}/v3/{project_id}/instances/{instance_id}/groups?offset=null&limit=null

Response Parameters

Normal response

**Table 4** Response body parameters
Parameter	Type	Description
total_count	Integer	Total records
group_list	Array of Table 5 objects	Instance group information

**Table 5** GroupInfo
Parameter	Type	Description
id	String	Group ID
name	String	Group name
role	String	Group role type, which can be read/write or read-only. Returned values: rw: read/write group r: read-only group
endpoint	String	Connection address of the group. If load balancing is not enabled, the connection address string of the node in the group is returned.
ipv6_endpoint	String	IPv6 connection address of the group
is_load_balance	Boolean	Whether load balancing is enabled
is_default_group	Boolean	Whether the API group is the default group
cpu_num_per_node	Integer	Number of CPU cores per node
mem_num_per_node	Integer	Memory size per node, in GB
architecture	String	CPU architecture Returned values: x86 Arm
node_list	Array of objects (Table 6)	Node information list

**Table 6** GroupNodeInfo
Parameter	Type	Description
id	String	Node ID
name	String	Node name
az	String	AZ to which the node belongs

Example Response

Normal response example

{ 
    "group_list":[ 
        { 
            "id":"****gr09", 
            "name":"group-default", 
            "role":"rw", 
            "endpoint":"**.**.**.**:5066", 
            "is_load_balance":true, 
            "is_default_group":false, 
            "architecture":"X86", 
            "cpu_num_per_node":4, 
            "mem_num_per_node":8, 
            "node_list":[ 
                { 
                    "id":"****no09", 
                    "name":"node_01", 
                    "az":"some_az" 
                } 
            ] 
        } 
    ], 
    "total_count":1 
}