DescribeCenAttachedChildInstances - Cloud Enterprise Network

Queries the network instances that are attached to a 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.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that support authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cen:DescribeCenAttachedChildInstances

get

*CenInstance

acs:cen:*:{#accountId}:ceninstance/{#ceninstanceId}

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	object
ChildInstance	array<object>	The information about the network instances.
	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	integer	The ID of the Alibaba Cloud account to which the network instance belongs.	1688000000000000
ChildInstanceId	string	The ID of the network instance.	vpc-8vb1lu55yt9rlwgxl****
ManagedService	string	The cloud service that the network instance belongs to. Its standard code is only returned when the VPC is connected to the transit router. For self-managed VPCs, no code is returned.	swas
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
CenId	string	The ID of the CEN instance.	cen-j3jzhw1zpau2km****

Examples

Success response

JSON format

{
  "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****",
        "ManagedService": "swas",
        "ChildInstanceAttachTime": "2021-08-10T06:27Z",
        "CenId": "cen-j3jzhw1zpau2km****"
      }
    ]
  }
}

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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.