DescribeExpressConnectRouterChildInstance-阿里云帮助中心

Queries the virtual border routers (VBRs) loaded on an Express Connect Router (ECR).

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 supports 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

expressconnectrouter:DescribeExpressConnectRouterChildInstance

list

*ExpressConnectRouter

acs:expressconnectrouter::{#accountId}:expressconnectrouter/{#EcrId}

None

Request parameters

Parameter	Type	Required	Description	Example
EcrId	string	Yes	The ID of the Express Connect Router instance.	ecr-mezk2idmsd0vx2****
AssociationId	string	No	The association ID between the Express Connect Router and the VBR.	ecr-assoc-9p2qxx5phpca2m****
ChildInstanceId	string	No	The ID of the network instance to detach.	vbr-j6cwxhgg0s5nuephp****
ChildInstanceType	string	No	The type of the network instance. Valid value: VBR: virtual border router instance.	VBR
ChildInstanceRegionId	string	No	The region where the network instance is deployed.	cn-hangzhou
NextToken	string	No	The token for the next query. Valid values: Leave this parameter empty for the first query or when there is no subsequent query. If a subsequent query exists, set this parameter to the NextToken value returned in the previous API call.	AAAAAYws9fJ0Ur4MGm/5OkDoW/Zn0J0/sCjivzwX9oBcwFnWaaas/kSG+J/WzLOxJHS4****
MaxResults	integer	No	The maximum number of entries to return in this request. Valid values: 1 to 2147483647. Default value: 20.	20
DryRun	boolean	No	Specifies whether to perform only a dry run of the request. Valid values: true: Sends a validation request without modifying any service resources. false (default): Sends a normal request.	false
ClientToken	string	No	A client token used to ensure the idempotence of the request. Generate a unique value from your client for each request. ClientToken supports only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. Each API request has a unique RequestId.	02fb3da4-130e-11e9-8e44-00****

Response elements

Element	Type	Description	Example
	object	RpcResponse
RequestId	string	The ID of the request.	05130E79-588D-5C40-A718-C4863A59****
Success	boolean	Indicates whether the call succeeded. Valid values: True: The call succeeded. False: The call failed.	True
Code	string	Indicates whether the call succeeded. A return value of 200 indicates success. Any other value indicates failure. For details about failures, see error codes.	200
Message	string	The response message.	OK
HttpStatusCode	integer	The HTTP status code.	200
DynamicCode	string	The dynamic error code.	IllegalParamFormat.EcrId
DynamicMessage	string	The dynamic error message used to replace the `%s` placeholder in the ErrMessage field. Note If ErrMessage returns The Value of Input Parameter %s is not valid and DynamicMessage returns DtsJobId, the request parameter DtsJobId is invalid.	The param format of EcrId **** is illegal.
AccessDeniedDetail	string	Details about the access denial.	Authentication is failed for ****
TotalCount	integer	The total number of associated instances.	1
MaxResults	integer	The maximum number of entries returned in this request. Valid values: 1 to 2147483647. Default value: 20.	20
NextToken	string	The token for the next query. Valid values: An empty value indicates no subsequent query. A non-empty value indicates the token to start the next query.	AAAAAYws9fJ0Ur4MGm/5OkDoW/Zn0J0/sCjivzwX9oBcwFnWaaas/kSG+J/WzLOxJHS4****
ChildInstanceList	array<object>	The list of child instances.
	object	Information about the child instance.
EcrId	string	The ID of the Express Connect Router instance.	ecr-mezk2idmsd0vx2****
AssociationId	string	The association ID between the Express Connect Router and the VPC or TR.	ecr-assoc-9p2qxx5phpca2m****
RegionId	string	The region of the virtual border router.	cn-hangzhou
OwnerId	integer	The Alibaba Cloud account ID of the virtual border router owner.	167509154715****
GmtCreate	string	The time when the association was created. The time follows the ISO8601 standard in UTC. Format: YYYY-MM-DDThh:mm:ssZ.	2024-01-09T12:18:23Z
GmtModified	string	The time when the association was modified. The time follows the ISO8601 standard in UTC. Format: YYYY-MM-DDThh:mm:ssZ.	2024-01-09T12:18:23Z
Status	string	The deployment status of the associated instance. Valid values: CREATING: Creating. ACTIVE: Created. ASSOCIATING: Associating. DISSOCIATING: Dissociating. UPDATING: Updating. DELETING: Deleting.	ACTIVE
ChildInstanceId	string	The ID of the virtual border router instance.	vbr-gw8vjq2zjux3ifsc9****
ChildInstanceType	string	The type of the child instance. Valid value: VBR: virtual border router.	VBR
ChildInstanceRegionId	string	The region of the child instance.	cn-hangzhou
ChildInstanceOwnerId	integer	The Alibaba Cloud account ID of the child instance owner.	112101171212****
Description	string	The description of the child instance.	test
ChildInstanceName	string

Examples

Success response

JSON format

{
  "RequestId": "05130E79-588D-5C40-A718-C4863A59****",
  "Success": true,
  "Code": "200",
  "Message": "OK",
  "HttpStatusCode": 200,
  "DynamicCode": "IllegalParamFormat.EcrId",
  "DynamicMessage": "The param format of EcrId **** is illegal.\n",
  "AccessDeniedDetail": "Authentication is failed for ****\n",
  "TotalCount": 1,
  "MaxResults": 20,
  "NextToken": "AAAAAYws9fJ0Ur4MGm/5OkDoW/Zn0J0/sCjivzwX9oBcwFnWaaas/kSG+J/WzLOxJHS4****",
  "ChildInstanceList": [
    {
      "EcrId": "ecr-mezk2idmsd0vx2****",
      "AssociationId": "ecr-assoc-9p2qxx5phpca2m****",
      "RegionId": "cn-hangzhou",
      "OwnerId": 0,
      "GmtCreate": "2024-01-09T12:18:23Z",
      "GmtModified": "2024-01-09T12:18:23Z",
      "Status": "ACTIVE",
      "ChildInstanceId": "vbr-gw8vjq2zjux3ifsc9****",
      "ChildInstanceType": "VBR",
      "ChildInstanceRegionId": "cn-hangzhou",
      "ChildInstanceOwnerId": 0,
      "Description": "test ",
      "ChildInstanceName": ""
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParam.%s	The param of %s is missing.	The request parameters are not specified. Please check the corresponding parameters and try again.
400	IllegalParamFormat.%s	The param format of %s is illegal.	Illegal parameter format
400	IllegalParam.%s	The param of %s is illegal.	Illegal parameter
404	ResourceNotFound.EcrId	EcrId not found.	ECR instance does not exist

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.