All Products
Search
Document Center

Cloud Enterprise Network:DescribeGrantRulesToResource

Last Updated:Oct 22, 2024

Queries the information about the permissions that the Alibaba Cloud account of a network instance granted to a Cloud Enterprise Network (CEN) instance in a different Alibaba Cloud account, the ID of the CEN instance, and the Alibaba Cloud account that pays the fees of the network instance.

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:
    • The required resource types are displayed in bold characters.
    • 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
cen:DescribeGrantRulesToResourceget
  • VPC
    acs:vpc:*:{#accountId}:vpc/{#VpcId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The region ID of the network instance.

You can call the DescribeChildInstanceRegions operation to query the most recent region list.

cn-hangzhou
ResourceIdstringYes

The network instance ID.

vpc-p0wfut1iqauelpdpb****
ProductTypestringYes

The type of network instance. Valid values:

  • VPC: virtual private cloud (VPC)
  • ExpressConnect: virtual border router (VBR)
  • VPN: IPsec-VPN connection
  • ECR: Express Connect Router (ECR)
VPC
MaxResultsintegerNo
  • If you do not specify a value for MaxResults, entries are returned in one response. After you send the request, the value of MaxResults includes all entries.
  • If you specify a value for MaxResults, entries are returned in batches. The value of MaxResults indicates the total number of entries returned per batch. Valid values: 1 to 100. After you send the request, the value of MaxResults indicates the number of entries returned in the current response. We recommend that you set MaxResults to 20.
20
NextTokenstringNo

The pagination token that is used in the next request to retrieve a new page of results. Valid values:

  • You do not need to specify this parameter for the first request.
  • You must specify the token that is obtained from the previous query as the value of the NextToken parameter.
FFmyTO70tTpLG6I3FmYAXGKPd****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

NextTokenstring

The returned value of NextToken is a pagination token, which can be used in the next request to retrieve a new page of results. Valid values:

  • If the NextToken parameter is empty, no next page exists.
  • If a value is returned for NextToken, the value is the token that determines the start point of the next query.
FFmyTO70tTpLG6I3FmYAXGKPd****
RequestIdstring

The request ID.

C6E5992C-A57B-5A6C-9B26-568074DC68BA
TotalCountinteger

The total number of entries returned.

1
MaxResultsinteger
  • If no value is specified for MaxResults, query results are returned in one batch. The value of MaxResults indicates the total number of entries.
  • If a value is specified for MaxResults, query results are returned in batches. The value of MaxResults in the response indicates the number of entries in the current batch.
1
GrantRulesarray<object>

The permissions that are granted to the CEN instance.

GrantRuleobject
CenOwnerIdlong

The ID of the Alibaba Cloud account to which the CEN instance belongs.

1250123456123456
OrderTypestring

The entity that pays the fees of the network instance. Valid values: Valid values:

  • PayByCenOwner: The fees of the connections and data forwarding on the transit router are paid by the Alibaba Cloud account to which the CEN instance belongs.
  • PayByResourceOwner: The fees of the connections and data forwarding on the transit router are paid by the Alibaba Cloud account to which the network instance belongs.
PayByCenOwner
CenIdstring

The ID of the CEN instance.

cen-44m0p68spvlrqq****
CreateTimestring

The timestamp when the permissions were granted. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.

2024-01-24T16:46Z

Examples

Sample success responses

JSONformat

{
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "C6E5992C-A57B-5A6C-9B26-568074DC68BA",
  "TotalCount": 1,
  "MaxResults": 1,
  "GrantRules": [
    {
      "CenOwnerId": 1250123456123456,
      "OrderType": "PayByCenOwner",
      "CenId": "cen-44m0p68spvlrqq****",
      "CreateTime": "2024-01-24T16:46Z"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameterInvalid parameter. -
400MissingParameter Missing parameter.-
400InvalidParameter.RegionIdThe specified Region Id is invalid.The error message returned because the specified region ID is invalid.
400MissingParameter.RegionIdMissing RegionId parameter.Missing RegionId parameter.
400IllegalParam.NextTokenNextToken is illegalThe error message returned because the NextToken parameter is set to an invalid value.
400UnauthorizedThe AccessKeyId is unauthorized.The error message returned because you do not have the permissions to perform this operation.

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

Change history

Change timeSummary of changesOperation
2024-07-10The Error code has changedView Change Details
2024-07-08The Error code has changedView Change Details
2023-12-26API Description Update. The Error code has changed. The response structure of the API has changedView Change Details
2022-09-22Add OperationView Change Details