文档首页/ 云连接 CC/ API参考/ API/ 中心网络管理/ 查询所有版本的中心网络策略列表
更新时间:2024-11-14 GMT+08:00

查询所有版本的中心网络策略列表

功能介绍

查询所有版本的中心网络策略列表。

分页查询使用的参数为marker、limit。limit默认值为0,没有指定marker时返回第一条数据。

调用方法

请参见如何调用API

URI

GET https://cc.myhuaweicloud.com/v3/{domain_id}/gcn/central-network/{central_network_id}/policies

表1 路径参数

参数

是否必选

参数类型

描述

domain_id

String

账号ID。

central_network_id

String

中心网络的ID。

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

每页返回的个数。

取值范围:1~1000。

marker

String

翻页信息,从上次API调用返回的翻页数据中获取,可填写前一页marker或者后一页marker,填入前一页previous_marker就向前翻页,后一页next_marker就向后翻页。 翻页过程中,查询条件不能修改,包括过滤条件、排序条件、limit。

sort_key

String

排序字段。

sort_dir

Object

指定排序是升序还是降序(asc为升序,desc为降序)。

id

Array of arrays

根据ID查询,可查询多个ID。

state

Array of arrays

根据状态查询,可查询多个状态。

version

Array of arrays

根据版本查询,可查询多个名字。

is_applied

Boolean

是否被应用。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

request_id

String

请求ID。

page_info

PageInfo object

分页查询页的信息。

central_network_policies

Array of CentralNetworkPolicy objects

中心网络策略列表。

表5 PageInfo

参数

参数类型

描述

next_marker

String

向后分页标识符。

previous_marker

String

向前分页标识符。

current_count

Integer

当前列表中资源数量。

表6 CentralNetworkPolicy

参数

参数类型

描述

id

String

实例ID。

created_at

String

实例创建时间。UTC时间格式,yyyy-MM-ddTHH:mm:ss。

domain_id

String

实例所属账号ID。

state

String

中心网络策略状态。

  • AVAILABLE (可用)

  • CANCELING (取消中)

  • APPLYING (应用中)

  • FAILED (失败)

  • DELETED (已刪除)

central_network_id

String

中心网络ID。

document_template_version

String

文档模板版本。

  • 2022.08.30 (2022.08.30)

is_applied

Boolean

是否被应用。

version

Integer

中心网络策略的版本。

document

CentralNetworkPolicyDocument object

中心网络策略文档。

表7 CentralNetworkPolicyDocument

参数

参数类型

描述

default_plane

String

中心网络默认平面的名字。

planes

Array of CentralNetworkPlaneDocument objects

中心网络平面列表。

er_instances

Array of AssociateErInstanceDocument objects

中心网络ER实例列表。

表8 CentralNetworkPlaneDocument

参数

参数类型

描述

name

String

实例名称。

associate_er_tables

Array of AssociateErTableDocument objects

关联的中心网络ER实例列表。

exclude_er_connections

Array of ExcludeErConnectionDocument objects

当自动连接所有ER实例时,排除中心网络的ER实例的连接。

表9 AssociateErTableDocument

参数

参数类型

描述

project_id

String

实例所属项目ID。

region_id

String

RegionID。

enterprise_router_id

String

企业路由器的ID。

enterprise_router_table_id

String

企业路由器的路由表ID。

表10 ExcludeErConnectionDocument

参数

参数类型

描述

[数组元素]

Array of AssociateErInstanceDocument objects

中心网络平面管理的ER连接

表11 AssociateErInstanceDocument

参数

参数类型

描述

enterprise_router_id

String

企业路由器的ID。

project_id

String

实例所属项目ID。

region_id

String

RegionID。

请求示例

查询中心网络策略列表

GET /v3/{domain_id}/gcn/central-network/{central_network_id}/policies

响应示例

状态码: 200

查询中心网络策略列表成功。

{
  "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代码示例

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
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)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

查询中心网络策略列表成功。

错误码

请参见错误码