调用DescribeCenAttachedChildInstances接口查询云企业网实例下已加载的网络实例信息。

API描述

通过本接口您可以使用以下三种方式查询云企业网实例已加载的网络实例的信息:

  • 通过指定查询CenId,查询云企业网实例下已加载的所有网络实例的信息。
  • 通过指定CenIdChildInstanceRegionId,查询云企业网实例在某一个地域下已加载的网络实例的信息。
  • 通过指定CenIdChildInstanceType,查询云企业网实例已加载的某一类型的网络实例的信息。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeCenAttachedChildInstances

要执行的操作,取值:DescribeCenAttachedChildInstances

CenId String cen-j3jzhw1zpau2km****

云企业网实例ID。

PageNumber Integer 1

查询页码。默认值为1

PageSize Integer 10

分页查询时每页显示的条目数。默认值为10,取值范围:1~50

ChildInstanceType String VPC

网络实例的类型,取值:

  • VPC:专有网络实例。
  • VBR:边界路由器实例。
  • CCN:云连接网实例。
ChildInstanceRegionId String cn-zhangjiakou

网络实例所属地域ID。

您可以通过调用DescribeRegions接口获取地域ID。

返回数据

名称 类型 示例值 描述
ChildInstances Array of ChildInstance

云企业网实例加载的网络实例信息列表。

ChildInstance
CenId String cen-j3jzhw1zpau2km****

云企业网实例ID。

ChildInstanceAttachTime String 2021-08-10T06:27Z

网络实例的加载时间。

时间按照ISO8601标准表示,并使用UTC时间。格式为:YYYY-MM-DDThh:mmZ。

ChildInstanceId String vpc-8vb1lu55yt9rlwgxl****

网络实例ID。

ChildInstanceOwnerId Long 1688000000000000

网络实例所属阿里云账号(主账号)ID。

ChildInstanceRegionId String cn-zhangjiakou

网络实例所属地域ID。

ChildInstanceType String VPC

网络实例的类型,取值:

  • VPC:专有网络实例。
  • VBR:边界路由器实例。
  • CCN:云连接网实例。
Status String Attached

网络实例的状态,取值:

  • Attaching:加载中。
  • Attached:已加载。
  • Detaching:卸载中。
PageNumber Integer 1

查询页码。

PageSize Integer 10

分页查询时每页显示的条目数。

RequestId String B2063B16-852B-5B66-B73D-4ED4D1A5E5C2

请求ID。

TotalCount Integer 1

总条目数。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeCenAttachedChildInstances
&CenId=cen-j3jzhw1zpau2km****
&<公共请求参数>

正常返回示例

XML格式

<DescribeCenAttachedChildInstancesResponse>
  <TotalCount>1</TotalCount>
  <PageSize>10</PageSize>
  <RequestId>B2063B16-852B-5B66-B73D-4ED4D1A5E5C2</RequestId>
  <PageNumber>1</PageNumber>
  <ChildInstances>
        <ChildInstance>
              <Status>Attached</Status>
              <ChildInstanceType>VPC</ChildInstanceType>
              <CenId>cen-j3jzhw1zpau2kmscxd</CenId>
              <ChildInstanceAttachTime>2021-08-10T06:27Z</ChildInstanceAttachTime>
              <ChildInstanceOwnerId>1688401595963306</ChildInstanceOwnerId>
              <ChildInstanceId>vpc-8vb1lu55yt9rlwgxlu83b</ChildInstanceId>
              <ChildInstanceRegionId>cn-zhangjiakou</ChildInstanceRegionId>
        </ChildInstance>
  </ChildInstances>
</DescribeCenAttachedChildInstancesResponse>

JSON格式

{
    "TotalCount": 1,
    "PageSize": 10,
    "RequestId": "B2063B16-852B-5B66-B73D-4ED4D1A5E5C2",
    "PageNumber": 1,
    "ChildInstances": {
        "ChildInstance": [
            {
                "Status": "Attached",
                "ChildInstanceType": "VPC",
                "CenId": "cen-j3jzhw1zpau2km****",
                "ChildInstanceAttachTime": "2021-08-10T06:27Z",
                "ChildInstanceOwnerId": 1688000000000000,
                "ChildInstanceId": "vpc-8vb1lu55yt9rlwgxl****",
                "ChildInstanceRegionId": "cn-zhangjiakou"
            }
        ]
    }
}

错误码

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