DescribeInstanceGrantedToExpressConnectRouter-阿里云帮助中心

Queries the network instances that are granted to 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:DescribeInstanceGrantedToExpressConnectRouter

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****
InstanceRegionId	string	No	The region where the authorized network instance is located.	cn-hangzhou
InstanceId	string	No	The ID of the authorized instance.	vbr-j6cwxhgg0s5nuephp****
InstanceOwnerId	integer	No	The ID of the Alibaba Cloud account to which the authorized network instance belongs.	1298452580502345
InstanceType	string	No	The type of the network instance. Valid values: VBR: virtual border router (VBR). VPC: virtual private cloud (VPC).	VBR
NextToken	string	No	The token that is used for the next query. You do not need to specify this parameter for the first query. For subsequent queries, set this parameter to the NextToken value returned from the previous API call.	gAAAAABkyGzFbZR2NnxnyVk0EiL7F3qMBtBim8Es0mugRT3qb8yEHAMaHGanzuaHUmiEq9QRmok0RgxJAINBOJZa5KPjopEu_Q==
MaxResults	integer	No	The maximum number of entries to return on each page. Valid values: 1 to 2,147,483,647. Default value: 20.	20
TagModels	array<object>	No	The list of tags.
	object	No
TagKey	string	No	The tag key. You can specify up to 20 tag keys. The tag key cannot be an empty string. The tag key can be up to 128 characters in length. It cannot start with `aliyun` or `acs:` and cannot contain `http://` or `https://`.	key
TagValue	string	No	The tag value. You can specify up to 20 tag values. The tag value cannot be an empty string. The tag value can be up to 128 characters in length. It cannot start with `aliyun` or `acs:` and cannot contain `http://` or `https://`.	value
ResourceGroupId	string	No	The ID of the resource group to which the instance belongs.	rg-aek2tsvbnfe****
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: sends a check request and does not modify service resources. false (default): sends a normal request.	true
ClientToken	string	No	A client token to ensure the idempotence of the request. The client token must be unique across requests. The token can contain only ASCII characters. Note If you do not specify this parameter, the system uses the RequestId of the API request as the ClientToken. The RequestId may be different for each API request.	02fb3da4-130e-11e9-8e44-00****
CallerType	string	No	The type of the caller. ECR OTHER Default value: ECR	ECR

Response elements

Element	Type	Description	Example
	object	RpcResponse
RequestId	string	The request ID.	6FABF516-FED3-5697-BDA2-B18C5D9A****
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	True
Code	string	The response code. A `200` response code indicates that the request was successful. For information about other response codes, see the Error codes section.	200
Message	string	The returned message.	OK
HttpStatusCode	integer	The HTTP status code.	200
DynamicCode	string	The dynamic error code.	IllegalParamFormat.Name
DynamicMessage	string	The dynamic error message. This message is used to replace the `%s` placeholder in the Message parameter. Note For example, if the Message parameter returns The Value of Input Parameter %s is not valid and the DynamicMessage parameter returns DtsJobId, the specified DtsJobId parameter is invalid.	The param format of Name **** is illegal.
AccessDeniedDetail	string	The details of the access denial.	Authentication is failed for ****
TotalCount	integer	The total number of network instances that are granted to the Express Connect Router.	10
MaxResults	integer	The maximum number of entries returned per page.	20
NextToken	string	The token that is used for the next query. If NextToken is empty, no subsequent query is needed. If a value is returned for NextToken, the value is the token that is used for the next query.	FFlMqGuJ10uN3l+FX/cBrGDNXUOUifNeOuAJlT4dc3vsWD6DsNSFAC2FtpeH5QOSG2WFdyRoun7gSLCm5o69YnAQ==
EcrGrantedInstanceList	array<object>	The list of authorized Express Connect Router instances.
	object
GrantId	string	The authorization ID.	gr-8gdelo13mi99g1****
Status	string	The status of the authorized network instance.	Active
GmtCreate	string	The time when the instance was created.	1669023139000
GmtModified	string	The time when the instance was modified.	1669023139000
EcrId	string	The ID of the Express Connect Router instance.	ecr-mezk2idmsd0vx2****
NodeId	string	The ID of the authorized instance.	vbr-j6cwxhgg0s5nuephp****
NodeType	string	The type of the network instance. Valid values: VBR: virtual border router (VBR). VPC: virtual private cloud (VPC).	VBR
NodeRegionId	string	The ID of the region to which the authorized instance belongs.	cn-hangzhou
NodeOwnerUid	integer	The ID of the Alibaba Cloud account to which the instance belongs.	129845258050****
NodeOwnerBid	string	The ID of the enterprise account to which the instance belongs.	26842****
EcrOwnerAliUid	string	The ID of the Alibaba Cloud account that owns the Express Connect Router instance.	229845258050****

Examples

Success response

JSON format

{
  "RequestId": "6FABF516-FED3-5697-BDA2-B18C5D9A****",
  "Success": true,
  "Code": "200",
  "Message": "OK",
  "HttpStatusCode": 200,
  "DynamicCode": "IllegalParamFormat.Name\n",
  "DynamicMessage": "The param format of Name **** is illegal.\n",
  "AccessDeniedDetail": "Authentication is failed for ****\n",
  "TotalCount": 10,
  "MaxResults": 20,
  "NextToken": "FFlMqGuJ10uN3l+FX/cBrGDNXUOUifNeOuAJlT4dc3vsWD6DsNSFAC2FtpeH5QOSG2WFdyRoun7gSLCm5o69YnAQ==",
  "EcrGrantedInstanceList": [
    {
      "GrantId": "gr-8gdelo13mi99g1****",
      "Status": "Active",
      "GmtCreate": "1669023139000",
      "GmtModified": "1669023139000",
      "EcrId": "ecr-mezk2idmsd0vx2****",
      "NodeId": "vbr-j6cwxhgg0s5nuephp****\n",
      "NodeType": "VBR",
      "NodeRegionId": "cn-hangzhou",
      "NodeOwnerUid": 0,
      "NodeOwnerBid": "26842****",
      "EcrOwnerAliUid": "229845258050****\n"
    }
  ]
}

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

See for a complete list.

Release notes

See Release Notes for a complete list.