DescribeGrantRulesToCen - Cloud Enterprise Network - Alibaba Cloud Documentation Center

You can call the DescribeGrantRulesToCen operation to query information about cross-account network instances that are authorized to a Cloud Enterprise Network (CEN) instance.

Operation description

Make sure that the parameter values are valid when you call the DescribeGrantRulesToCen operation. If you enter invalid parameters, the operation returns a RequestId but does not return information about the authorized cross-account network instances.

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 deployed. For more information, see DescribeChildInstanceRegions.	cn-hangzhou
CenId	string	Yes	The ID of the CEN instance.	cen-nye53d7p3hzyu4****
ProductType	string	Yes	The type of the network instance. Valid values: VPC: a virtual private cloud (VPC). VBR: a virtual border router (VBR). CCN: a Cloud Connect Network (CCN) instance. VPN: an IPsec connection. ECR: an Express Connect Router (ECR) instance.	VPC
MaxResults	integer	No	If you do not specify MaxResults, the query is not paged. The value of MaxResults in the response indicates the total number of entries. If you specify MaxResults, the query is paged. MaxResults specifies the number of entries to return on each page. The value must be an integer from 1 to 100. The value of MaxResults in the response indicates the number of entries on the current page. A value of 20 is recommended.	20
NextToken	string	No	The token for the next page of results. Valid values: Do not specify this parameter for the first query or if no next page exists. If a next page exists, set this parameter to the NextToken value returned from the previous API call.	FFmyTO70tTpLG6I3FmYAXGKPd****
ChildInstanceId	string	No	The ID of the network instance.	vpc-rj9gt5nll27onu7****
ChildInstanceOwnerId	integer	No	The ID of the Alibaba Cloud account that owns the network instance.	1250123456123456
EnabledIpv6	boolean	No	Specifies whether IPv6 is enabled: This parameter is valid only when ProductType is set to VPC. true indicates that IPv6 is enabled. false indicates that IPv6 is disabled. If you do not specify this parameter or leave it empty, the results are not filtered by this parameter.	true

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	4906B209-8613-5C19-9CC9-B7A3FFDA731C
GrantRules	object
GrantRule	array<object>	A list of permissions.
	object	The network instances.
ChildInstanceType	string	The type of the network instance. VPC: virtual private cloud. VBR: virtual border router. CCN: Cloud Connect Network instance. VPN: IPsec connection. ECR: Express Connect Router instance.	VPC
ChildInstanceRegionId	string	The ID of the region where the network instance is deployed.	cn-hangzhou
ChildInstanceOwnerId	integer	The ID of the Alibaba Cloud 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 fees for the transit router connection and traffic processing that are generated by the network instance. PayByResourceOwner: The account that owns the network instance pays the fees for the transit router connection and traffic processing that are generated by the network instance.	PayByCenOwner
CenOwnerId	integer	The ID of the Alibaba Cloud account that owns the CEN instance.	1210123456123456
CreateTime	integer	The time when the permission was granted. The time is displayed in UTC and follows the ISO 8601 standard in the YYYY-MM-DDThh:mmZ format.	2024-01-24T16:27Z
TotalCount	integer	The number of entries returned.	1
MaxResults	integer	If you do not specify the MaxResults parameter in the request, the query is not paged. The value of MaxResults in the response indicates the total number of entries. If you specify the MaxResults parameter in the request, the query is paged. The value of MaxResults in the response indicates the number of entries on the current page.	20
NextToken	string	The token for the next page of results. Valid values: If this parameter is empty, no more results are available. If a value is returned, the value is the token that you can use to retrieve the next page of results.	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",
        "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.