Querying the List of Central Network Policies
Function
This API is used to query the central network policies.
Parameters marker and limit are used for pagination query. The default value of limit is 0. If marker is not specified, the first data record is returned.
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
URI
GET /v3/{domain_id}/gcn/central-network/{central_network_id}/policies
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
domain_id |
Yes |
String |
Account ID. |
central_network_id |
Yes |
String |
Central network ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
limit |
No |
Integer |
Number of records on each page. Value range: 1 to 1000 |
marker |
No |
String |
Pagination query information. You can obtain the marker values from the response of the last API call. You can enter the marker value of the previous page or the next page. If you enter the marker value of the previous page, the previous page will be queried. If you enter the marker value of the next page, the next page will be queried. During pagination query, the query criteria, including the filters, sorting criteria, and the limit value, cannot be modified. |
sort_key |
No |
String |
Field for sorting. |
sort_dir |
No |
Object |
Whether the resources are sorted in ascending or descending order. asc indicates the ascending order and desc indicates the descending order. |
id |
No |
Array of arrays |
Resource ID. Multiple IDs can be queried. |
state |
No |
Array of arrays |
Policy status. Multiple statuses can be queried. |
version |
No |
Array of arrays |
Version. Multiple versions can be queried. |
is_applied |
No |
Boolean |
Whether the policy is applied or not. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
No |
String |
User token. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Request ID. |
page_info |
PageInfo object |
Pagination query information. |
central_network_policies |
Array of CentralNetworkPolicy objects |
List of the central network policies. |
Parameter |
Type |
Description |
---|---|---|
next_marker |
String |
Backward pagination identifier. |
previous_marker |
String |
Forward pagination identifier. |
current_count |
Integer |
Number of the resources in the current list. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Instance ID. |
created_at |
String |
Time when the resource was created. The time is in the yyyy-MM-ddTHH:mm:ss format. |
domain_id |
String |
ID of the account that the instance belongs to. |
state |
String |
Central network policy status.
|
central_network_id |
String |
Central network ID. |
document_template_version |
String |
Document template version.
|
is_applied |
Boolean |
Whether the policy is applied or not. |
version |
Integer |
Version of the central network policy. |
document |
CentralNetworkPolicyDocument object |
Central network policy document. |
Parameter |
Type |
Description |
---|---|---|
default_plane |
String |
Name of the default central network plane. |
planes |
Array of CentralNetworkPlaneDocument objects |
List of the central network planes. |
er_instances |
Array of AssociateErInstanceDocument objects |
List of the enterprise routers on the central network. |
Parameter |
Type |
Description |
---|---|---|
name |
String |
Instance name. |
associate_er_tables |
Array of AssociateErTableDocument objects |
List of the enterprise routers on the central network. |
exclude_er_connections |
Array of ExcludeErConnectionDocument objects |
Whether to exclude the connections to enterprise routers on the central network. |
Parameter |
Type |
Description |
---|---|---|
project_id |
String |
Project ID. |
region_id |
String |
Region ID. |
enterprise_router_id |
String |
Enterprise router ID. |
enterprise_router_table_id |
String |
ID of the enterprise router route table. |
Parameter |
Type |
Description |
---|---|---|
[items] |
Array of AssociateErInstanceDocument objects |
Connections between enterprise routers managed by the central network plane. |
Example Requests
Querying the list of central network policies
GET /v3/{domain_id}/gcn/central-network/{central_network_id}/policies
Example Responses
Status code: 200
The central network policy list has been queried.
{ "request_id" : "76bfd2b0d492d0e479fbbd3981869c12", "page_info" : { "current_count" : 1 }, "central_network_policies" : [ { "id" : "f03478aa-3975-4ca7-9fb2-b49428a01636", "created_at" : "2023-10-09T06:22:40.857Z", "domain_id" : "XXX", "state" : "AVAILABLE", "central_network_id" : "e096c86f-817c-418c-945c-6b1d8860a15d", "document_template_version" : "2022.08.30", "is_applied" : true, "version" : 1, "document" : { "default_plane" : "default-plane", "planes" : [ { "name" : "default-plane", "associate_er_tables" : [ { "project_id" : "XXX", "region_id" : "region-abc", "enterprise_router_id" : "395b0884-aab4-4bf0-8cb8-7f2da26708dd", "enterprise_router_table_id" : "cc542128-5c2d-402a-8960-53bb2ed9484e" } ] } ], "er_instances" : [ { "enterprise_router_id" : "395b0884-aab4-4bf0-8cb8-7f2da26708dd", "project_id" : "XXX", "region_id" : "region-abc" } ] } } ] }
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 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.GlobalCredentials; 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.cc.v3.region.CcRegion; import com.huaweicloud.sdk.cc.v3.*; import com.huaweicloud.sdk.cc.v3.model.*; public class ListCentralNetworkPoliciesSolution { 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"); ICredential auth = new GlobalCredentials() .withAk(ak) .withSk(sk); CcClient client = CcClient.newBuilder() .withCredential(auth) .withRegion(CcRegion.valueOf("<YOUR REGION>")) .build(); ListCentralNetworkPoliciesRequest request = new ListCentralNetworkPoliciesRequest(); request.withCentralNetworkId("{central_network_id}"); try { ListCentralNetworkPoliciesResponse response = client.listCentralNetworkPolicies(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 GlobalCredentials from huaweicloudsdkcc.v3.region.cc_region import CcRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcc.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"] credentials = GlobalCredentials(ak, sk) client = CcClient.new_builder() \ .with_credentials(credentials) \ .with_region(CcRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListCentralNetworkPoliciesRequest() request.central_network_id = "{central_network_id}" response = client.list_central_network_policies(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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global" cc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/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") auth := global.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := cc.NewCcClient( cc.CcClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListCentralNetworkPoliciesRequest{} request.CentralNetworkId = "{central_network_id}" response, err := client.ListCentralNetworkPolicies(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 central network policy list has been queried. |
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