DescribeCloudConnectNetworks - 查询已创建的云连接网

更新时间:
复制 MD 格式

查询指定地域下已创建的云连接网实例信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

smartag:DescribeCloudConnectNetworks

get

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

RegionId

string

是

云连接网实例所属地域 ID。

cn-shanghai

Name

string

否

云连接网实例名称。

名称长度为 2~100 个字符,以大小写字母或中文开头,可包含数字、下划线(_)、半角句号(.)和短划线(-)。

ccnname

CcnId

string

否

云连接网实例 ID。

ccn-l9340rlu5enst*****

PageSize

integer

否

分页查询时每页包含的条目数,默认值为 10,最大值为 50。

10

PageNumber

integer

否

查询页码,默认值是 1。

1

Tag

array<object>

否

通过标签信息查找云连接网实例。

DescribeCloudConnectNetworks

object

否

标签信息。

Key

string

否

标签键。

test

Value

string

否

标签值。

test

返回参数

名称

类型

描述

示例值

object

查询结果。

CloudConnectNetworks

object

CloudConnectNetwork

array<object>

云连接网实例信息列表。

array<object>

云连接网实例信息。

AssociatedCenId

string

云连接网实例绑定的云企业网实例 ID。

cen-0jtu0bcbika5b5****

AssociatedCenOwnerId

string

已加载该云连接网实例的云企业网实例的账号 ID。

168800000000****

AssociatedCenStatus

string

CCN 绑定 CEN 的状态,只在 NewAgw 返回 true 时候才有值,有如下状态:Binding(绑定中)、Unbinding(解绑中)、BindFailed(绑定失败)、UnbindFailed(解绑失败)、Bound(已绑定)、Unbound(未绑定)

枚举值:

  • Binding
  • Unbinding
  • BindFailed
  • UnbindFailed
  • Bound
  • Unbound

Binding

AssociatedCloudBoxCount

string

云连接网实例绑定的智能接入网关实例数量。

1

AssociatedVpcStatus

string

CCN 绑定 VPC 的状态,只在 NewAgw 返回 true 时候才有值,有如下状态:Binding(绑定中)、Unbinding(解绑中)、BindFailed(绑定失败)、UnbindFailed(解绑失败)、Bound(已绑定)、Unbound(未绑定)

枚举值:

  • Binding
  • Unbinding
  • BindFailed
  • UnbindFailed
  • Bound
  • Unbound

Bound

AvailableCloudBoxCount

string

云连接网实例已绑定的智能接入网关实例中状态为可用的智能接入网关实例的数量。

1

CcnId

string

云连接网实例 ID。

ccn-l9340rlu5enst******

CenStatusErrorCode

string

绑定/解绑 CEN 失败错误码,只在 NewAgw 返回 true,且 AssociatedCenStatus 为 BindFailed/UnbindFailed 时才会返回。

VRM_FAILED

CenStatusErrorMessage

string

绑定/解绑 CEN 失败错误消息,只在 NewAgw 返回 true,且 AssociatedCenStatus 为 BindFailed/UnbindFailed 时才会返回。

Backend resource creation failed.

CidrBlock

string

私网网段。

10.10.10.0/24

CreateTime

integer

云连接网实例的创建时间戳。

1523618639000

Description

string

云连接网实例的描述信息。

ccndesc

InterworkingStatus

string

是否允许已绑定同一个云连接网实例的智能接入网关实例互通。

  • enable:允许。

  • disable:不允许。

enable

Name

string

云连接网实例的名称。

ccnname

NewAgw

boolean

云连接网是否支持新 AGW。

true

ProcessingCenId

string

绑定/解绑进行中或失败时的目标 CEN ID。只在 NewAgw 返回 true,且 AssociatedCenStatus 为 Binding/Unbinding/BindFailed/UnbindFailed 时才会返回。

cen-0jtu0bcbika5b5****

ResourceGroupId

string

云连接网实例所属的资源组 ID。

rg-acfm2iu4fnc****

SnatCidrBlock

string

SNAT 网段。

10.10.10.0/25

Subnet

string

云连接网绑定云企业网使用的互联网段。

192.168.20.0/24

Tags

object

Tag

array<object>

标签信息列表。

object

标签信息。

Key

string

标签键。

test

Value

string

标签值。

test

TrNetworkConfig

object

CCN 绑定的 TR 数据。

CidrAllocationMode

string

网段分配模式,PER_REGION 每个 Region 各自自定义,UNIFIED 统一分配。

枚举值:

  • UNIFIED
  • PER_REGION

PER_REGION

RegionBindingList

object

RegionBinding

array<object>

绑定的 TR 列表

object

CidrBlock

string

私网网段。

192.168.189.0/24

RegionId

string

TR 所属的地域 ID。

cn-shanghai

RelayCidrBlock

string

中继 VPC 所使用的网段。

192.168.189.0/24

Status

string

单个 Region 的绑定状态,只在 NewAgw 返回 true 时候才有值,有如下状态:Binding(绑定中)、Unbinding(解绑中)、BindFailed(绑定失败)、UnbindFailed(解绑失败)、Bound(已绑定)、Unbound(未绑定)

Bound

TransitRouterId

string

转发路由器的 ID。

tr-t4n7z1tuxeir5htqudzb4

Subnet

string

云连接网绑定云企业网使用的互联网段。

172.16.0.0/24

VpcNetworkConfig

object

CCN 绑定的 VPC 数据。

CidrAllocationMode

string

网段分配模式,PER_REGION 每个 Region 各自自定义,UNIFIED 统一分配。

枚举值:

  • UNIFIED
  • PER_REGION

PER_REGION

RegionBindingList

object

RegionBinding

array<object>

绑定的 VPC 列表。

object

RegionId

string

VPC 的地域 ID。

cn-shanghai

RelayCidrBlock

string

中继 VPC 所使用的网段。

192.168.33.0/24

Status

string

单个 Region 的绑定状态,只在 NewAgw 返回 true 时候才有值,有如下状态:Binding(绑定中)、Unbinding(解绑中)、BindFailed(绑定失败)、UnbindFailed(解绑失败)、Bound(已绑定)、Unbound(未绑定)

Bound

VpcCidrBlock

string

VPC 使用的网段。

192.168.2.0/24

VpcId

string

VPC 的实例 ID。

vpc-uf62cymqhob8nx3ti9iud

Subnet

string

云连接网绑定云企业网使用的互联网段。

192.168.0.0/16

VpcStatusErrorCode

string

绑定/解绑 VPC 失败错误码,只在 NewAgw 返回 true,且 AssociatedCenStatus 为 BindFailed/UnbindFailed 时才会返回。

-1001

VpcStatusErrorMessage

string

绑定/解绑 VPC 失败错误消息,只在 NewAgw 返回 true,且 AssociatedCenStatus 为 BindFailed/UnbindFailed 时才会返回。

Backend resource creation failed.

PageNumber

integer

查询页码。

1

PageSize

integer

分页查询时每页包含的条目数。

10

RequestId

string

请求 ID。

3F2A0B80-D6D1-4764-8D77-38067DBBA345

TotalCount

integer

总条目数。

3

示例

正常返回示例

JSON格式

{
  "CloudConnectNetworks": {
    "CloudConnectNetwork": [
      {
        "AssociatedCenId": "cen-0jtu0bcbika5b5****",
        "AssociatedCenOwnerId": "168800000000****",
        "AssociatedCenStatus": "Binding",
        "AssociatedCloudBoxCount": "1",
        "AssociatedVpcStatus": "Bound",
        "AvailableCloudBoxCount": "1",
        "CcnId": "ccn-l9340rlu5enst******",
        "CenStatusErrorCode": "VRM_FAILED",
        "CenStatusErrorMessage": "Backend resource creation failed.",
        "CidrBlock": "10.10.10.0/24",
        "CreateTime": 1523618639000,
        "Description": "ccndesc",
        "InterworkingStatus": "enable",
        "Name": "ccnname",
        "NewAgw": true,
        "ProcessingCenId": "cen-0jtu0bcbika5b5****\n",
        "ResourceGroupId": "rg-acfm2iu4fnc****",
        "SnatCidrBlock": "10.10.10.0/25",
        "Subnet": "192.168.20.0/24",
        "Tags": {
          "Tag": [
            {
              "Key": "test",
              "Value": "test"
            }
          ]
        },
        "TrNetworkConfig": {
          "CidrAllocationMode": "PER_REGION",
          "RegionBindingList": {
            "RegionBinding": [
              {
                "CidrBlock": "192.168.189.0/24",
                "RegionId": "cn-shanghai",
                "RelayCidrBlock": "192.168.189.0/24",
                "Status": "Bound",
                "TransitRouterId": "tr-t4n7z1tuxeir5htqudzb4"
              }
            ]
          },
          "Subnet": "172.16.0.0/24"
        },
        "VpcNetworkConfig": {
          "CidrAllocationMode": "PER_REGION",
          "RegionBindingList": {
            "RegionBinding": [
              {
                "RegionId": "cn-shanghai",
                "RelayCidrBlock": "192.168.33.0/24",
                "Status": "Bound",
                "VpcCidrBlock": "192.168.2.0/24",
                "VpcId": "vpc-uf62cymqhob8nx3ti9iud"
              }
            ]
          },
          "Subnet": "192.168.0.0/16"
        },
        "VpcStatusErrorCode": "-1001",
        "VpcStatusErrorMessage": "Backend resource creation failed."
      }
    ]
  },
  "PageNumber": 1,
  "PageSize": 10,
  "RequestId": "3F2A0B80-D6D1-4764-8D77-38067DBBA345",
  "TotalCount": 3
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidTagKey The specified tag key is invalid. Tag标签的Key值不合法。
400 InvalidTagValue The specified tag value is invalid. Tag标签的Value值不合法。
400 SizeLimitExceeded.TagNum The maximum number of tags is exceeded. Tag个数超过了最大数量。
400 SizeLimitExceeded.ResourceId The maximum number of resource IDs is exceeded. ResourceIds个数超过了最大数量。
400 Forbidden.TagKey.Duplicated The specified tag key already exists. TagKey存在相同的值。
403 Forbidden User not authorized to operate on the specified resource. 用户没有操作此资源的权限。

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。