Queries whether Anti-DDoS Origin is authorized to obtain information about the assets within the current Alibaba Cloud account. The assets can be elastic IP addresses (EIPs). The assets can also be Elastic Compute Service (ECS) instances or Server Load Balancer (SLB) instances that are assigned public IP addresses.

Usage notes

You can call the CheckGrant operation to query whether Anti-DDoS Origin is authorized to obtain information about the assets within the current Alibaba Cloud account.

Limits

You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes CheckGrant

The operation that you want to perform. Set the value to CheckGrant.

ResourceGroupId String No rg-acfm2pz25js****

The ID of the resource group to which the Anti-DDoS Origin instance belongs in Resource Management.

If you do not specify this parameter, the instance belongs to the default resource group.

RegionId String No cn-hangzhou

The ID of the region where the Anti-DDoS Origin instance resides.

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

All Alibaba Cloud API operations must include common request parameters. For more information about common request parameters, see Common parameters.

For more information about sample requests, see the "Examples" section of this topic.

Response parameters

Parameter Type Example Description
Status Integer 1

Indicates whether Anti-DDoS Origin is authorized to obtain information about the assets within the current Alibaba Cloud account. Valid values:

  • 1: Anti-DDoS Origin is authorized to obtain information about the assets within the current Alibaba Cloud account.
  • 0: Anti-DDoS Origin is not authorized to obtain information about the assets within the current Alibaba Cloud account.
RequestId String DB002CE5-5E6C-5F11-AE15-B525299A40F6

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=CheckGrant
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<CheckGrantResponse>
    <Status>1</Status>
    <RequestId>DB002CE5-5E6C-5F11-AE15-B525299A40F6</RequestId>
</CheckGrantResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Status" : 1,
  "RequestId" : "DB002CE5-5E6C-5F11-AE15-B525299A40F6"
}

Error codes

For a list of error codes, visit the API Error Center.