All Products
Search
Document Center

Cloud Enterprise Network:DescribeCenAttachedChildInstances

Last Updated:Apr 11, 2023

Queries the network instances that are attached to a Cloud Enterprise Network (CEN) instance.

Operation Description

You can use one of the following methods to query the information about the network instances that are attached to a CEN instance:

  • You can query all the network instances that are attached to a CEN instance by setting the CenId parameter.
  • You can query the network instances that are attached to a CEN instance in a specified region by setting the CenId and ChildInstanceRegionId parameters.
  • You can query a specified type of network instances that are attached to a CEN instance by setting the CenId and ChildInstanceType parameters.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociation operation
cen:DescribeCenAttachedChildInstancesREAD
  • CEN
    acs:cen:*:{#accountId}:ceninstance/{#ceninstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PageNumberintegerNo

The number of the page to return. Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each page. Default value: 10. Valid values: 1 to 50.

10
CenIdstringYes

The ID of the CEN instance.

cen-j3jzhw1zpau2km****
ChildInstanceTypestringNo

The type of the network instance. Valid values:

  • VPC: virtual private cloud (VPC)
  • VBR: virtual border router (VBR)
  • CCN: Cloud Connect Network (CCN) instance
VPC
ChildInstanceRegionIdstringNo

The ID of the region where the network instance is deployed.

You can call the DescribeRegions operation to query the most recent region list.

cn-zhangjiakou

Response parameters

ParameterTypeDescriptionExample
object
PageSizeinteger

The number of entries returned per page.

10
RequestIdstring

The ID of the request.

B2063B16-852B-5B66-B73D-4ED4D1A5E5C2
PageNumberinteger

The page number of the returned page.

1
TotalCountinteger

The total number of entries returned.

1
ChildInstancesarray

The information about the network instances.

object
ChildInstanceTypestring

The type of the network instance. Valid values:

  • VPC: VPC
  • VBR: VBR
  • CCN: CCN instance
VPC
Statusstring

The status of the network instance. Valid values:

  • Attaching: The network instance is being created on the transit router.
  • Attached: The network instance has been created on the transit router.
  • Detaching: The network instance is being deleted from the transit router.
Attached
ChildInstanceRegionIdstring

The ID of the region where the network instance is deployed.

cn-zhangjiakou
ChildInstanceOwnerIdlong

The ID of the Alibaba Cloud account to which the network instance belongs.

1688000000000000
ChildInstanceIdstring

The ID of the network instance.

vpc-8vb1lu55yt9rlwgxl****
CenIdstring

The ID of the CEN instance.

cen-j3jzhw1zpau2km****
ChildInstanceAttachTimestring

The time when the network instance was attached to the CEN instance.

The time follows the ISO8601 standard in the YYYY-MM-DDThh:mmZ format. The time is displayed in UTC.

2021-08-10T06:27Z

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.