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 *
-
-
-
-
g:EnterpriseProjectId
URI
GET /v3/{project_id}/vpc/list-address-groups-dependency
| 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. |
| 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
| 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. |
| 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 |
| Parameter | Type | Description |
|---|---|---|
| type | String | Definition: Type of the resource associated with an IP address group. Range: |
| 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 (.). |
| 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
}
} SDK Sample Code
The SDK sample code is as follows.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 | package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.vpc.v3.region.VpcRegion; import com.huaweicloud.sdk.vpc.v3.*; import com.huaweicloud.sdk.vpc.v3.model.*; public class ListAddressGroupsDependencySolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); VpcClient client = VpcClient.newBuilder() .withCredential(auth) .withRegion(VpcRegion.valueOf("<YOUR REGION>")) .build(); ListAddressGroupsDependencyRequest request = new ListAddressGroupsDependencyRequest(); try { ListAddressGroupsDependencyResponse response = client.listAddressGroupsDependency(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 | # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkvpc.v3.region.vpc_region import VpcRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkvpc.v3 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = VpcClient.new_builder() \ .with_credentials(credentials) \ .with_region(VpcRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListAddressGroupsDependencyRequest() response = client.list_address_groups_dependency(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 | package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" vpc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpc/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpc/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpc/v3/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := vpc.VpcClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := vpc.NewVpcClient(hcClient) request := &model.ListAddressGroupsDependencyRequest{} response, err := client.ListAddressGroupsDependency(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
| Status Code | Description |
|---|---|
| 200 | The GET operation is successful. For more status codes, see Status Codes. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot