DescribeExpressConnectRouterChildInstance - Express Connect

Queries the virtual border routers (VBRs) associated with 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 (ECR) instance.	ecr-mezk2idmsd0vx2****
AssociationId	string	No	The ID of the association between the ECR and the virtual border router (VBR).	ecr-assoc-9p2qxx5phpca2m****
ChildInstanceId	string	No	The ID of the child instance.	vbr-j6cwxhgg0s5nuephp****
ChildInstanceType	string	No	The type of the child instance. Set the value to VBR to specify a VBR instance.	VBR
ChildInstanceRegionId	string	No	The region ID of the child instance.	cn-hangzhou
NextToken	string	No	The token for the next page of results. Valid values: You do not need to specify this parameter for the first request. To retrieve the next page of results, set this parameter to the NextToken value returned from the previous request.	AAAAAYws9fJ0Ur4MGm/5OkDoW/Zn0J0/sCjivzwX9oBcwFnWaaas/kSG+J/WzLOxJHS4****
MaxResults	integer	No	The maximum number of entries to return per page. Valid values: 1 to 2147483647. Default value: 20.	20
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: performs a dry run to check the request. The system does not modify 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 the token from your client. Make sure the token is unique among different requests. The token can contain only ASCII characters. Note If you do not specify this parameter, the system uses the RequestId as the ClientToken. The RequestId may be different for each request.	02fb3da4-130e-11e9-8e44-00****

Response elements

Element	Type	Description	Example
	object	RpcResponse<DescribeChildInstanceResponse>
RequestId	string	The request ID.	05130E79-588D-5C40-A718-C4863A59****
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	True
Code	string	The status code of the request. A value of 200 indicates that the request was successful. Other values indicate that the request failed. For more information, see the "Error codes" section of this topic.	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 that is used to replace the `%s` placeholder in the error message. Note For example, if the value of ErrMessage is `The Value of Input Parameter %s is not valid` and the value of DynamicMessage is `DtsJobId`, the specified `DtsJobId` parameter 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 entries returned.	1
MaxResults	integer	The maximum number of entries returned per page. Valid values: 1 to 2147483647. Default value: 20.	20
NextToken	string	The token for the next page of results. Valid values: If this parameter is empty, all results have been returned. If a value is returned, use this token for the next request.	AAAAAYws9fJ0Ur4MGm/5OkDoW/Zn0J0/sCjivzwX9oBcwFnWaaas/kSG+J/WzLOxJHS4****
ChildInstanceList	array<object>	A list of child instances.
	object	The details of the child instance.
EcrId	string	The ID of the ECR instance.	ecr-mezk2idmsd0vx2****
AssociationId	string	The ID of the association between the ECR and the VBR.	ecr-assoc-9p2qxx5phpca2m****
RegionId	string	The region ID of the VBR.	cn-hangzhou
OwnerId	integer	The ID of the Alibaba Cloud account to which the VBR belongs.	167509154715****
GmtCreate	string	The time when the association was created. The time is displayed in the `YYYY-MM-DDThh:mm:ssZ` format and is in UTC.	2024-01-09T12:18:23Z
GmtModified	string	The time when the association was last modified. The time is displayed in the `YYYY-MM-DDThh:mm:ssZ` format and is in UTC.	2024-01-09T12:18:23Z
Status	string	The status of the child instance. Valid values: CREATING: The resource is being created. ACTIVE: The resource is created. ASSOCIATING: The resource is being attached. DISSOCIATING: The resource is being detached. UPDATING: The resource is being modified. DELETING: The resource is being deleted.	ACTIVE
ChildInstanceId	string	The ID of the VBR instance.	vbr-gw8vjq2zjux3ifsc9****
ChildInstanceType	string	The type of the child instance. The value is VBR, which indicates a VBR.	VBR
ChildInstanceRegionId	string	The region ID of the child instance.	cn-hangzhou
ChildInstanceOwnerId	integer	The ID of the Alibaba Cloud account to which the child instance belongs.	112101171212****
Description	string	The description of the child instance.	test

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 "
    }
  ]
}

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.