Querying Resources Associated with an IP Address Group

Function

This API is used to query the IDs and names of the network ACLs or security groups associated with an IP address group.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
vpc:addressGroups:list	List	addressGroup *	-	-	-
vpc:addressGroups:list	List	-	g:EnterpriseProjectId	-	-

URI

GET /v3/{project_id}/vpc/list-address-groups-dependency

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: ID of the project that an IP address group belongs to. For details about how to obtain a project ID, see Obtaining a Project ID. Range: N/A.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
id	No	String	Definition: ID of an IP address group that will be used as a filter. Range: N/A.
enterprise_project_id	No	String	Definition: ID of the enterprise project that an IP address group belongs to that will be used as a filter. Range: N/A.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
request_id	String	Definition: Request ID. Range: N/A.
address_groups	Array of AddressGroupDependency objects	Definition: Response body for querying the resources associated with an address group. Range: N/A.
page_info	PageInfo object	Definition: Pagination information. Range: N/A.

**Table 4** AddressGroupDependency
Parameter	Type	Description
id	String	Definition: ID of an IP address group. After an IP address group is created, an IP address group ID is generated, which uniquely identifies the IP address group. Range: The value is in UUID format with hyphens (-).
enterprise_project_id	String	Definition: ID of the enterprise project that an IP address group belongs to. Range: The value is 0 or a string that contains a maximum of 36 characters in the UUID format with hyphens (-). 0 indicates the default enterprise project.
dependency	Array of Dependency objects	Definition: Resources associated with an IP address group. Range: N/A

**Table 5** Dependency
Parameter	Type	Description
type	String	Definition: Type of the resource associated with an IP address group. Range: sg: An IP address group is associated with a security group. acl: An IP address group is associated with a network ACL.
instance_id	String	Definition: ID of the resource associated with an IP address group. Range: The value is in UUID format with hyphens (-).
instance_name	String	Definition: Name of the resource associated with an IP address group. Range: The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).

**Table 6** PageInfo
Parameter	Type	Description
previous_marker	String	Definition: The first record on the current page. Range: N/A
current_count	Integer	Definition: Total number of resources on the current page. Range: N/A
next_marker	String	Definition: The last record on the current page. The next_marker field does not exist if the page is the last one. Range: N/A

Example Requests

Query the network ACLs or security groups associated with an IP address group.

GET https://{Endpoint}/v3/2bc7a67b35a64a79ad1d3bb8b5f61fc9/vpc/list-address-groups-dependency?id={address_group_id}

Example Responses

Status code: 200

The GET operation is successful. For more status codes, see Status Codes.

{
  "request_id" : "8ede499276cf61d82bea7afde3ace82d",
  "address_groups" : [ {
    "id" : "551691cf-400a-43f2-8e12-576c34558e52",
    "enterprise_project_id" : "0",
    "dependency" : [ {
      "type" : "acl",
      "instance_id" : "8197f5f0-4b73-40c6-b041-8b97271afaef",
      "instance_name" : "fw-test"
    }, {
      "type" : "sg",
      "instance_id" : "9a644a13-198f-4f34-b2ab-227632131f71",
      "instance_name" : "sg-test"
    } ]
  } ],
  "page_info" : {
    "previous_marker" : "551691cf-400a-43f2-8e12-576c34558e52",
    "current_count" : 1
  }
}