Use DescribeGrantRulesToCen to query authorized cross-account network instances - Cloud Enterprise Network

Call the DescribeGrantRulesToCen API to query the cross-account network instances that have been authorized for a CEN instance.

Operation description

Calling the DescribeGrantRulesToCen interface with invalid parameters returns a RequestId but provides no information about the cross-account network instances that the Cloud Enterprise Network (CEN) instance is permitted to access.

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

cen:DescribeGrantRulesToCen

get

*CenInstance

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The ID of the region where the network instance is located. You can call the DescribeChildInstanceRegions operation to query region IDs.	cn-hangzhou
CenId	string	Yes	The ID of the Cloud Enterprise Network instance.	cen-nye53d7p3hzyu4****
ProductType	string	Yes	The type of the network instance. Valid values: VPC: a VPC. VBR: a VBR. CCN: a CCN instance. VPN: an IPsec connection. ECR: an Express Connect Router instance.	VPC
MaxResults	integer	No	If you omit this parameter, all entries are returned. The MaxResults value in the response then indicates the total number of entries. If you set this parameter, the response is paginated. The MaxResults value specifies the number of entries to return on each page. Valid values: 1 to 100. The MaxResults value in the response indicates the number of entries on the current page. Setting MaxResults to 20 is recommended.	20
NextToken	string	No	The token used to retrieve the next page of results. Omit this parameter for the first request. Set this parameter to the NextToken value from the previous response to retrieve the next page of results.	FFmyTO70tTpLG6I3FmYAXGKPd****
ChildInstanceId	string	No	The ID of the network instance to query.	vpc-rj9gt5nll27onu7****
ChildInstanceOwnerId	integer	No	The ID of the Alibaba Cloud account (root account) that owns the network instance.	1250123456123456
EnabledIpv6	boolean	No	Specifies whether IPv6 is enabled. This parameter applies only when ProductType is set to VPC. Set to true to return only VPCs with IPv6 enabled, or false to return only those with IPv6 disabled. If you omit this parameter, the response is not filtered by the IPv6 status.	true

Response elements

Element	Type	Description	Example
	object	The data returned.
RequestId	string	The request ID.	4906B209-8613-5C19-9CC9-B7A3FFDA731C
GrantRules	object	The grant rules.
GrantRule	array<object>	A list of grant rules.
	object	The details of the network instance.
ChildInstanceType	string	The type of the network instance. Valid values: VPC: A VPC. VBR: A VBR. CCN: A CCN. VPN: An IPsec connection. ECR: An ECR.	VPC
ChildInstanceRegionId	string	The region ID of the network instance.	cn-hangzhou
ChildInstanceOwnerId	integer	The ID of the Alibaba Cloud account (primary account) that owns the network instance.	1250123456123456
ChildInstanceId	string	The ID of the network instance.	vpc-bp1rgeww9mdstuuar****
CenId	string	The ID of the CEN instance.	cen-nye53d7p3hzyu4****
OrderType	string	The payer for the network instance. Valid values: PayByCenOwner: The account that owns the CEN instance pays the transit router connection and data transfer fees for the network instance. PayByResourceOwner: The account that owns the network instance pays the transit router connection and data transfer fees for the network instance.	PayByCenOwner
EffectiveOrderType	string	The effective payer for the network instance.	PayByCenOwner
CenOwnerId	integer	The ID of the Alibaba Cloud account (primary account) that owns the CEN instance.	1210123456123456
CreateTime	integer	The time when the permission was granted. The time is in UTC and follows the ISO 8601 standard.	2024-01-24T16:27Z
TotalCount	integer	The total number of entries.	1
MaxResults	integer	The maximum number of entries to return per page. This value is the same as the MaxResults value that you specified in the request.	20
NextToken	string	The pagination token that is used in the next request to retrieve a new page of results. If the NextToken parameter is empty, no more results are available. To retrieve the next page, set the NextToken request parameter to this value.	FFmyTO70tTpLG6I3FmYAXGKPd****

Examples

Success response

JSON format

{
  "RequestId": "4906B209-8613-5C19-9CC9-B7A3FFDA731C",
  "GrantRules": {
    "GrantRule": [
      {
        "ChildInstanceType": "VPC",
        "ChildInstanceRegionId": "cn-hangzhou",
        "ChildInstanceOwnerId": 1250123456123456,
        "ChildInstanceId": "vpc-bp1rgeww9mdstuuar****",
        "CenId": "cen-nye53d7p3hzyu4****",
        "OrderType": "PayByCenOwner",
        "EffectiveOrderType": "PayByCenOwner",
        "CenOwnerId": 1210123456123456,
        "CreateTime": 0
      }
    ]
  },
  "TotalCount": 1,
  "MaxResults": 20,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****"
}

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	MissingParameter	Missing parameter.	The error message returned because one or more required parameters are not set.
400	InvalidParameter.RegionId	The specified Region Id is invalid.	The error message returned because the specified region ID is invalid.
400	IllegalParam.NextToken	NextToken is illegal	The error message returned because the NextToken parameter is set to an invalid value.
400	MissingParameter.RegionId	Missing RegionId parameter.	Missing RegionId parameter.
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.