All Products
Search
Document Center

Express Connect:DescribeExpressConnectRouterChildInstance

Last Updated:Mar 17, 2025

Queries the virtual border routers (VBRs) that are associated with an Express Connect router (ECR).

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.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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 keyAssociated operation
expressconnectrouter:DescribeExpressConnectRouterChildInstancelist
*ExpressConnectRouter
acs:expressconnectrouter::{#accountId}:expressconnectrouter/{#EcrId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
EcrIdstringYes

The ECR ID.

ecr-mezk2idmsd0vx2****
AssociationIdstringNo

The ID of the association between the ECR and the virtual private cloud (VPC) or transit router (TR).

ecr-assoc-9p2qxx5phpca2m****
ChildInstanceIdstringNo

The ID of the network instance to be queried.

vbr-j6cwxhgg0s5nuephp****
ChildInstanceTypestringNo

The type of network instance. Set the value to VBR.

VBR
ChildInstanceRegionIdstringNo

The region ID of the network instance.

cn-hangzhou
NextTokenstringNo

A pagination token. It can be used in the next request to retrieve a new page of results. Valid values:

  • If NextToken is empty, no next page exists.
  • If a value of NextToken is returned, the value indicates the token that is used for the next query.
AAAAAYws9fJ0Ur4MGm/5OkDoW/Zn0J0/sCjivzwX9oBcwFnWaaas/kSG+J/WzLOxJHS4****
MaxResultsintegerNo

The maximum number of entries to read. Valid values: 1 to 2147483647. Default value: 20.

10
DryRunbooleanNo

Specifies whether to perform only a dry run, without performing the actual request. Valid values:

  • true: performs only a dry run.
  • false (default): performs a dry run and performs the actual request.
false
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request.

You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters.

Note If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.
02fb3da4-130e-11e9-8e44-00****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

05130E79-588D-5C40-A718-C4863A59****
Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
True
Codestring

The response code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed. For more information, see Error codes.

200
Messagestring

The returned message.

OK
HttpStatusCodeinteger

The HTTP status code.

200
DynamicCodestring

The dynamic error code.

IllegalParamFormat.EcrId
DynamicMessagestring

The dynamic part in the error message. This parameter is used to replace the %s variable in ErrMessage.

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 request parameter DtsJobId is invalid.
The param format of EcrId **** is illegal.
AccessDeniedDetailstring

The details about the access denial.

Authentication is failed for ****
TotalCountinteger

The total number of associated resources.

1
MaxResultsinteger

The total number of entries returned. Valid values: 1 to 2147483647. Default value: 20.

20
NextTokenstring

A pagination token. It can be used in the next request to retrieve a new page of results. Valid values:

  • If NextToken is empty, no next page exists.
  • If a value of NextToken is returned, the value indicates the token that is used for the next query.
AAAAAYws9fJ0Ur4MGm/5OkDoW/Zn0J0/sCjivzwX9oBcwFnWaaas/kSG+J/WzLOxJHS4****
ChildInstanceListarray<object>

The VBRs.

ChildInstanceListobject

The VBRs.

EcrIdstring

The ECR ID.

ecr-mezk2idmsd0vx2****
AssociationIdstring

The ID of the association between the ECR and the VPC or TR.

ecr-assoc-9p2qxx5phpca2m****
RegionIdstring

The region ID of the VBR.

cn-hangzhou
OwnerIdlong

The ID of the Alibaba Cloud account that owns the VBR.

167509154715****
GmtCreatestring

The time when the association was created. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.

2024-01-09T12:18:23Z
GmtModifiedstring

The time when the association was modified. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.

2024-01-09T12:18:23Z
Statusstring

The deployment state of the associated resource. Valid values:

  • CREATING: The resource is being created.
  • ACTIVE: The resource is created.
  • ASSOCIATING: The resource is being associated.
  • DISSOCIATING: The resource is being disassociated.
  • UPDATING: The resource is being modified.
  • DELETING: The resource is being deleted.
ACTIVE
ChildInstanceIdstring

The VBR ID.

vbr-gw8vjq2zjux3ifsc9****
ChildInstanceTypestring

The type of the VBR. The value is VBR.

VBR
ChildInstanceRegionIdstring

The region ID of the VBR.

cn-hangzhou
ChildInstanceOwnerIdlong

The ID of the Alibaba Cloud account that owns the VBR.

112101171212****
Descriptionstring

The description of the ECR.

test

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
400MissingParam.%sThe param of %s is missing.The request parameters are not specified. Please check the corresponding parameters and try again.
400IllegalParamFormat.%sThe param format of %s is illegal.Illegal parameter format
400IllegalParam.%sThe param of %s is illegal.Illegal parameter
404ResourceNotFound.EcrIdEcrId not found.ECR instance does not exist

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

Change history

Change timeSummary of changesOperation
2024-10-17The Error code has changed. The response structure of the API has changedView Change Details
2024-06-28API Description Update. The Error code has changedView Change Details
2024-03-26The Error code has changed. The response structure of the API has changedView Change Details