DescribeCenAttachedChildInstances - Cloud Enterprise Network

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.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
cen:DescribeCenAttachedChildInstances	get	CenInstance acs:cen:*:{#accountId}:ceninstance/{#ceninstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The number of the page to return. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Default value: 10. Valid values: 1 to 50.	10
CenId	string	Yes	The ID of the CEN instance.	cen-j3jzhw1zpau2km****
ChildInstanceType	string	No	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
ChildInstanceRegionId	string	No	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

Parameter	Type	Description	Example
	object
PageSize	integer	The number of entries returned per page.	10
RequestId	string	The ID of the request.	B2063B16-852B-5B66-B73D-4ED4D1A5E5C2
PageNumber	integer	The page number of the returned page.	1
TotalCount	integer	The total number of entries returned.	1
ChildInstances	array<object>	The information about the network instances.
ChildInstance	object
ChildInstanceType	string	The type of the network instance. Valid values: VPC: VPC VBR: VBR CCN: CCN instance	VPC
Status	string	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
ChildInstanceRegionId	string	The ID of the region where the network instance is deployed.	cn-zhangjiakou
ChildInstanceOwnerId	long	The ID of the Alibaba Cloud account to which the network instance belongs.	1688000000000000
ChildInstanceId	string	The ID of the network instance.	vpc-8vb1lu55yt9rlwgxl****
CenId	string	The ID of the CEN instance.	cen-j3jzhw1zpau2km****
ChildInstanceAttachTime	string	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

HTTP status code	Error code	Error message	Description
400	InvalidParameter	Invalid parameter.	The error message returned because the parameter is set to an invalid value.
400	Unauthorized	The AccessKeyId is unauthorized.	The error message returned because you do not have the permissions to perform this operation.

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