All Products
Search
Document Center

Cloud Enterprise Network:DescribeGrantRulesToCen

Last Updated:Oct 22, 2024

Queries the network instances of other Alibaba Cloud accounts that have granted permissions to a Cloud Enterprise Network (CEN) instance.

Operation description

Before you call the DescribeGrantRulesToCen operation, make sure that all request parameters are valid. If a request parameter is invalid, a request ID is returned, but the network instances are not returned.

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:DescribeGrantRulesToCenget
  • CenInstance
    acs:cen:*:{#accountId}:ceninstance/{#ceninstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the network instance.

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

cn-hangzhou
CenIdstringYes

The CEN instance ID.

cen-nye53d7p3hzyu4****
ProductTypestringYes

The type of the network instance. Valid values:

  • VPC
  • VBR
  • CCN
  • VPN
VPC
MaxResultslongNo
  • If you do not set MaxResults, it indicates that you do not need to query results in batches. The value of MaxResults in the response indicates the total number of entries returned.
  • If you specify a value for MaxResults, it indicates that you need to query results in batches. The value of MaxResults indicates the number of entries to return in each batch. Valid values: 1 to 100. The value of MaxResults in the response indicates the number of entries in the current batch. 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 NextToken.
FFmyTO70tTpLG6I3FmYAXGKPd****
ChildInstanceIdstringNo

The ID of the network instance that you want to query.

vpc-rj9gt5nll27onu7****
ChildInstanceOwnerIdlongNo

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

125012345612****
EnabledIpv6booleanNo

Specifies whether to enable IPv6.

  1. This parameter takes effect only if ProductType is set to VPC.
  2. true: enables IPv6. false: disables IPv6. If you do not specify a value, network instances are not filtered based on this parameter.
true

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

4906B209-8613-5C19-9CC9-B7A3FFDA731C
GrantRulesarray<object>

The permissions that are granted to the CEN instance.

GrantRuleobject

The queried network instances.

ChildInstanceTypestring

The type of the network instance. Valid values:

  • VPC: VPC
  • VBR: VBR
  • CCN: CCN instance
  • VPN: IPsec-VPN connection
VPC
ChildInstanceRegionIdstring

The region ID of the network instance.

cn-hangzhou
ChildInstanceOwnerIdlong

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

1250123456123456
ChildInstanceIdstring

The ID of the network instance.

vpc-bp1rgeww9mdstuuar****
CenIdstring

The ID of the CEN instance.

cen-nye53d7p3hzyu4****
OrderTypestring

The entity that pays the fees of the network instance. 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
CenOwnerIdlong

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

1210123456123456
CreateTimelong

The time when the permissions were granted to the CEN instance.

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

2024-01-24T16:27Z
TotalCountlong

The total number of entries returned.

1
MaxResultslong
  • 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, it indicates that you need to query results in batches. The value of MaxResults in the response indicates the number of entries in the current batch.
20
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 NextToken is empty, no next page exists.
  • If a value of NextToken was returned in the previous query, specify the value to obtain the next set of results.
FFmyTO70tTpLG6I3FmYAXGKPd****

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
400InvalidParameterInvalid parameter.The error message returned because the parameter is set to an invalid value.
400MissingParameterMissing parameter.The error message returned because one or more required parameters are not set.
400InvalidParameter.RegionIdThe specified Region Id is invalid.The error message returned because the specified region ID is invalid.
400IllegalParam.NextTokenNextToken is illegalThe error message returned because the NextToken parameter is set to an invalid value.
400MissingParameter.RegionIdMissing RegionId parameter.Missing RegionId parameter.
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-09-10The Error code has changed. The request parameters of the API has changedView Change Details
2024-07-10The Error code has changedView Change Details
2024-07-08The Error code has changedView Change Details
2023-12-26The Error code has changed. The response structure of the API has changedView Change Details
2023-05-05The Error code has changed. The request parameters of the API has changedView Change Details