全部产品
Search
文档中心

智能接入网关:DescribeCloudConnectNetworks - 查询已创建的云连接网

更新时间:Mar 29, 2024

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
smartag:DescribeCloudConnectNetworksRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
RegionIdstring

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

cn-shanghai
Namestring

云连接网实例名称。

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

ccnname
CcnIdstring

云连接网实例 ID。

ccn-l9340rlu5enst*****
PageSizeinteger

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

10
PageNumberinteger

查询页码,默认值是 1

1
Tagobject []

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

Keystring

标签键。

test
Valuestring

标签值。

test

返回参数

名称类型描述示例值
object

查询结果。

CloudConnectNetworksobject []

云连接网实例信息列表。

CreateTimelong

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

1523618639000
AssociatedCenOwnerIdstring

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

168800000000****
AssociatedCloudBoxCountstring

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

1
Tagsobject []

标签信息列表。

Keystring

标签键。

test
Valuestring

标签值。

test
InterworkingStatusstring

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

  • enable:允许。
  • disable:不允许。
enable
CcnIdstring

云连接网实例 ID。

ccn-l9340rlu5enst******
AvailableCloudBoxCountstring

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

1
CidrBlockstring

私网网段。

10.10.10.0/24
Descriptionstring

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

ccndesc
SnatCidrBlockstring

SNAT 网段。

10.10.10.0/25
AssociatedCenIdstring

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

cen-0jtu0bcbika5b5****
Namestring

云连接网实例的名称。

ccnname
ResourceGroupIdstring

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

rg-acfm2iu4fnc****
TotalCountinteger

总条目数。

3
PageSizeinteger

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

10
RequestIdstring

请求 ID。

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

查询页码。

1

示例

正常返回示例

JSON格式

{
  "CloudConnectNetworks": {
    "CloudConnectNetwork": [
      {
        "CreateTime": 1523618639000,
        "AssociatedCenOwnerId": "168800000000****",
        "AssociatedCloudBoxCount": "1",
        "Tags": {
          "Tag": [
            {
              "Key": "test",
              "Value": "test"
            }
          ]
        },
        "InterworkingStatus": "enable",
        "CcnId": "ccn-l9340rlu5enst******",
        "AvailableCloudBoxCount": "1",
        "CidrBlock": "10.10.10.0/24",
        "Description": "ccndesc",
        "SnatCidrBlock": "10.10.10.0/25",
        "AssociatedCenId": "cen-0jtu0bcbika5b5****",
        "Name": "ccnname",
        "ResourceGroupId": "rg-acfm2iu4fnc****"
      }
    ]
  },
  "TotalCount": 3,
  "PageSize": 10,
  "RequestId": "3F2A0B80-D6D1-4764-8D77-38067DBBA345",
  "PageNumber": 1
}

错误码

HTTP status code错误码错误信息描述
400InvalidTagKeyThe specified tag key is invalid.Tag标签的Key值不合法。
400InvalidTagValueThe specified tag value is invalid.Tag标签的Value值不合法。
400SizeLimitExceeded.TagNumThe maximum number of tags is exceeded.Tag个数超过了最大数量。
400SizeLimitExceeded.ResourceIdThe maximum number of resource IDs is exceeded.ResourceIds个数超过了最大数量。
400Forbidden.TagKey.DuplicatedThe specified tag key already exists.TagKey存在相同的值。
403ForbiddenUser not authorized to operate on the specified resource.用户没有操作此资源的权限。

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