应用中心网络策略 - ApplyCentralNetworkPolicy
功能介绍
应用中心网络策略。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
cc:centralNetwork:applyPolicy
Write
centralNetwork *
-
g:EnterpriseProjectId
-
g:ResourceTag/<tag-key>
-
- er:instances:get
- er:routeTables:get
- er:routeTables:listPropagations
- er:routeTables:enablePropagation
- er:routeTables:disablePropagation
- er:routeTables:listAssociations
- er:routeTables:associate
- er:routeTables:disassociate
-
URI
POST /v3/{domain_id}/gcn/central-network/{central_network_id}/policies/{policy_id}/apply
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
domain_id |
是 |
String |
账号ID。 |
|
policy_id |
是 |
String |
网络策略ID。 |
|
central_network_id |
是 |
String |
中心网络的ID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
否 |
String |
用户Token。 |
响应参数
状态码：202
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
request_id |
String |
请求ID。 |
|
central_network_policy |
CentralNetworkPolicy object |
中心网络策略详情。 |
|
central_network_policy_change_set |
Array of CentralNetworkElementChangeEntry objects |
网络策略变化列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
实例ID。 |
|
created_at |
String |
实例创建时间。UTC时间格式，yyyy-MM-ddTHH:mm:ss。 |
|
domain_id |
String |
实例所属账号ID。 |
|
state |
String |
中心网络策略状态。
|
|
central_network_id |
String |
中心网络ID。 |
|
document_template_version |
String |
文档模板版本。
|
|
is_applied |
Boolean |
是否被应用。 |
|
version |
Integer |
中心网络策略的版本。 |
|
document |
CentralNetworkPolicyDocument object |
中心网络策略文档。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
default_plane |
String |
中心网络默认平面的名称。 |
|
planes |
Array of CentralNetworkPlaneDocument objects |
中心网络平面列表。 |
|
er_instances |
Array of AssociateErInstanceDocument objects |
中心网络ER实例列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
name |
String |
实例名称。 |
|
associate_er_tables |
Array of AssociateErTableDocument objects |
关联的中心网络ER实例列表。 |
|
exclude_er_connections |
Array of ExcludeErConnectionDocument objects |
当自动连接所有ER实例时，排除中心网络的ER实例的连接。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
operation_id |
String |
实例状态。
|
|
create_central_network_plane |
中心网络平面文档。 |
|
|
original_central_network_plane |
中心网络平面文档。 |
|
|
newest_central_network_plane |
中心网络平面文档。 |
|
|
delete_central_network_plane |
中心网络平面文档。 |
|
|
create_central_network_er_instance |
AssociateErInstanceDocument object |
中心网络实例详情。 |
|
delete_central_network_er_instance |
AssociateErInstanceDocument object |
中心网络实例详情。 |
|
central_network_plane_name |
String |
中心网络平面名称。 |
|
create_central_network_er_connection |
Array of AssociateErTableDocument objects |
中心网络平面关联的ER路由表。 |
|
delete_central_network_er_connection |
Array of AssociateErTableDocument objects |
中心网络平面关联的ER路由表。 |
|
create_central_network_er_table |
AssociateErTableDocument object |
中心网络平面关联的ER路由表。 |
|
delete_central_network_er_table |
AssociateErTableDocument object |
中心网络平面关联的ER路由表。 |
|
switch_central_network_er_table |
SwitchErTableDocument object |
切换中心网络ER路由表文档。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
name |
String |
实例名称。 |
|
is_default |
Boolean |
是否默认平面。 |
|
associate_er_tables |
Array of AssociateErTableDocument objects |
关联的中心网络ER实例列表。 |
|
exclude_er_connections |
Array of ExcludeErConnectionDocument objects |
当自动连接所有ER实例时，排除中心网络的ER实例的连接。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
[数组元素] |
Array of AssociateErInstanceDocument objects |
中心网络平面管理的ER连接 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
enterprise_router_id |
String |
企业路由器的ID。 |
|
project_id |
String |
实例所属项目ID。 |
|
region_id |
String |
RegionID。 |
请求示例
应用中心网络策略
GET /v3/{domain_id}/gcn/central-network/{central_network_id}/policies
响应示例
状态码：202
接受应用中心网络策略的请求。
{
"request_id" : "edb137a2c46c5bda0409833359bb649b",
"central_network_policy" : {
"id" : "ff51f460-4bbe-4385-b2c4-efbe3318076f",
"created_at" : "2023-10-09T07:00:33.663Z",
"domain_id" : "XXX",
"state" : "APPLYING",
"central_network_id" : "e096c86f-817c-418c-945c-6b1d8860a15d",
"document_template_version" : "2022.08.30",
"is_applied" : false,
"version" : 2,
"document" : {
"default_plane" : "default-plane",
"planes" : [ {
"name" : "default-plane",
"associate_er_tables" : [ {
"project_id" : "XXX",
"region_id" : "region-abc",
"enterprise_router_id" : "c73b26b7-33f0-438d-b440-8e87dfe6fef9",
"enterprise_router_table_id" : "c0d51f20-0313-40f7-a74e-9dccb5da21c0"
} ]
} ],
"er_instances" : [ {
"enterprise_router_id" : "c73b26b7-33f0-438d-b440-8e87dfe6fef9",
"project_id" : "XXX",
"region_id" : "region-abc"
} ]
}
},
"central_network_policy_change_set" : [ {
"operation_id" : "UpdateCentralNetworkPlane",
"original_central_network_plane" : {
"name" : "default-plane",
"is_default" : true,
"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"
} ]
},
"newest_central_network_plane" : {
"name" : "default-plane",
"is_default" : true,
"associate_er_tables" : [ {
"project_id" : "XXX",
"region_id" : "region-abc",
"enterprise_router_id" : "c73b26b7-33f0-438d-b440-8e87dfe6fef9",
"enterprise_router_table_id" : "c0d51f20-0313-40f7-a74e-9dccb5da21c0"
} ]
}
}, {
"operation_id" : "CreateCentralNetworkErInstance",
"create_central_network_er_instance" : {
"enterprise_router_id" : "c73b26b7-33f0-438d-b440-8e87dfe6fef9",
"project_id" : "XXX",
"region_id" : "region-abc"
}
}, {
"operation_id" : "DeleteCentralNetworkErInstance",
"delete_central_network_er_instance" : {
"enterprise_router_id" : "395b0884-aab4-4bf0-8cb8-7f2da26708dd",
"project_id" : "XXX",
"region_id" : "region-abc"
}
}, {
"operation_id" : "CreateCentralNetworkErConnection",
"central_network_plane_name" : "default-plane",
"index" : 0,
"create_central_network_er_connection" : [ {
"project_id" : "XXX",
"region_id" : "region-abc-1",
"enterprise_router_id" : "c9c9c756-6984-4866-bab7-5b55c81594bd",
"enterprise_router_table_id" : "58613052-f9d4-4fa4-a3f0-6d6873190826"
}, {
"project_id" : "8d01a037388442f6a2e435f4f30860a3",
"region_id" : "region-abc-2",
"enterprise_router_id" : "58fad9c1-b4bd-4622-84e4-a0fcb2423601",
"enterprise_router_table_id" : "a5347056-e29f-4192-9256-e151c61f854c"
} ]
}, {
"operation_id" : "DeleteCentralNetworkErConnection",
"central_network_plane_name" : "default-plane",
"index" : 1,
"delete_central_network_er_connection" : [ {
"project_id" : "XXX",
"region_id" : "region-abc-1",
"enterprise_router_id" : "c9c9c756-6984-4866-bab7-5b55c81594bd",
"enterprise_router_table_id" : "58613052-f9d4-4fa4-a3f0-6d6873190826"
}, {
"project_id" : "8d01a037388442f6a2e435f4f30860a3",
"region_id" : "region-abc-2",
"enterprise_router_id" : "58fad9c1-b4bd-4622-84e4-a0fcb2423601",
"enterprise_router_table_id" : "a5347056-e29f-4192-9256-e151c61f854c"
} ]
}, {
"operation_id" : "CreateCentralNetworkErTable",
"central_network_plane_name" : "default-plane",
"create_central_network_er_table" : {
"project_id" : "XXX",
"region_id" : "region-abc",
"enterprise_router_id" : "c73b26b7-33f0-438d-b440-8e87dfe6fef9",
"enterprise_router_table_id" : "c0d51f20-0313-40f7-a74e-9dccb5da21c0"
}
}, {
"operation_id" : "DeleteCentralNetworkErTable",
"central_network_plane_name" : "default-plane",
"delete_central_network_er_table" : {
"project_id" : "XXX",
"region_id" : "region-abc",
"enterprise_router_id" : "395b0884-aab4-4bf0-8cb8-7f2da26708dd",
"enterprise_router_table_id" : "cc542128-5c2d-402a-8960-53bb2ed9484e"
}
}, {
"operation_id" : "SwitchCentralNetworkErTable",
"central_network_plane_name" : "default-plane",
"switch_central_network_er_table" : {
"project_id" : "XXX",
"region_id" : "region-abc",
"enterprise_router_id" : "5cc75ed0-bd6c-3af4-663b-caba3315bb08",
"original_enterprise_router_table_id" : "b705f49e-df88-eaf3-3aeb-95d534138156",
"new_enterprise_router_table_id" : "b705f49e-df88-eaf3-3aeb-95d534138158"
}
} ]
}
SDK代码示例
SDK代码示例如下。
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.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 ApplyCentralNetworkPolicySolution { 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(); ApplyCentralNetworkPolicyRequest request = new ApplyCentralNetworkPolicyRequest(); request.withPolicyId("{policy_id}"); request.withCentralNetworkId("{central_network_id}"); try { ApplyCentralNetworkPolicyResponse response = client.applyCentralNetworkPolicy(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 32 |
# 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 = ApplyCentralNetworkPolicyRequest() request.policy_id = "{policy_id}" request.central_network_id = "{central_network_id}" response = client.apply_central_network_policy(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 |
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.ApplyCentralNetworkPolicyRequest{} request.PolicyId = "{policy_id}" request.CentralNetworkId = "{central_network_id}" response, err := client.ApplyCentralNetworkPolicy(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例，请参见API Explorer的代码示例页签，可生成自动对应的SDK代码示例。
状态码
|
状态码 |
描述 |
|---|---|
|
202 |
接受应用中心网络策略的请求。 |
错误码
请参见错误码。
