Querying Details of an IP Address Group

Function

This API is used to query details of an IP address group.

URI

GET /v3/{project_id}/vpc/address-groups/{address_group_id}

**Table 1** Parameter description
Parameter	Mandatory	Type	Description
address_group_id	Yes	String	IP address group ID that uniquely identifies the IP address group.
project_id	Yes	String	Project ID. For details about how to obtain a project ID, see Obtaining a Project ID.

Request Parameter

None

Example Request

Querying details of an IP address group

"GET https://{Endpoint}/v3/2bc7a67b35a64a79ad1d3bb8b5f61fc9/vpc/address-groups/dd18a501-fcd5-4adc-acfe-b0e2384baf08"

Response Parameter

When the status code is 200, the response parameters are as follows:

**Table 2** Response body parameters
Parameter	Type	Description
request_id	String	Request ID
address_group	AddressGroup object	Response body of querying an IP address group

**Table 3** AddressGroup
Parameter	Type	Description
id	String	IP address group ID that uniquely identifies the IP address group. The value is a string in UUID format.
name	String	IP address group name. The value can contain up to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).
description	String	Provides supplementary information about an IP address group. The value can contain up to 255 characters. The value cannot contain angle brackets (< or >).
ip_set	Array of strings	IP address sets in an IP address group. The value can be a single IP address, IP address range, or CIDR block. The default maximum number of IP address sets, including IP addresses, IP address ranges, and CIDR blocks, in an IP address group is 20.
ip_version	Integer	Whether it is an IPv4 or IPv6 address group. The value can be: 4: IPv4 address group. 6: IPv6 address group.
created_at	String	Time (UTC) when the IP address group is created. The value must be the UTC time in the format of yyyy-MM-ddTHH:mmss.
updated_at	String	Time (UTC) when the IP address group was last updated. The value must be the UTC time in the format of yyyy-MM-ddTHH:mmss.
tenant_id	String	ID of the project to which the IP address group belongs.
max_capacity	Integer	Maximum number of IP addresses or IP address ranges in an IP address group. The value can be from 0 to 20. The default value is 20.
enterprise_project_id	String	Enterprise project ID. The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value 0 indicates the default enterprise project. Maximum length: 36 This parameter is available in CN South-Shenzhen, CN Southwest-Guiyang1, CN South-Guangzhou, AP-Singapore, CN East-Shanghai1, and CN North-Beijing4.
tags	Array of ResourceTag objects	IP address group tags.
status	String	IP address group status. Value range (Default value: NORMAL) NORMAL UPDATING UPDATE_FAILED An IP address group in the UPDATING state cannot be updated again.
status_message	String	IP address group status details.
ip_extra_set	Array of IpExtraSetRespOption objects	IP address sets and their remarks in an IP address group.

**Table 4** ResourceTag
Parameter	Type	Description
key	String	Tag key. Each key value of a resource must be unique. Minimum length: 1 Maximum length: 128
value	String	Tag value Maximum length: 255

**Table 5** IpExtraSetOption
Parameter	Mandatory	Type	Description
ip	Yes	String	An IP address, IP address range, or CIDR block. Both IPv4 and IPv6 are supported.
remarks	No	String	Provides supplementary information about the IP address, IP address range, or CIDR block. The value can contain up to 255 characters and cannot contain angle brackets (< or >).

Example Response

When the status code is 200, the response parameters are as follows:

Normal response for the GET operation of the API for querying an IP address group

{
    "address_group": {
        "id": "dd18a501-fcd5-4adc-acfe-b0e2384baf08", 
        "name": "AutoTester746010.580123789", 
        "tenant_id": "b2782e6708b8475c993e6064bc456bf8", 
        "ip_version": 4, 
        "ip_set": [
            "192.168.5.0/24", 
            "192.168.3.20-192.168.3.100", 
            "192.168.3.40", 
            "192.168.3.2"
        ], 
        "ip_extra_set": [{
	    "ip": "192.168.5.0/24",
	    "remarks": null
	},
	{
            "ip": "192.168.3.20-192.168.3.100",
	    "remarks": null
	},
	{
	    "ip": "192.168.3.40",
	    "remarks": null
	},
	{
	    "ip": "192.168.3.2",
	    "remarks": null
	}],
        "created_at": "2019-06-28T02:06:38", 
        "updated_at": "2019-06-28T02:06:38", 
        "description": "10.10.4.0/23",
        "enterprise_project_id": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2",
        "tags": [],
        "max_capacity": 20,
        "status": "NORMAL",
        "status_message": ""
    }, 
    "request_id": "ce6c359b-9002-41e5-a0b1-232759bd6637"
}