Checks whether Anti-DDoS Pro or Anti-DDoS Premium is authorized to access other cloud services.

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 DescribeStsGrantStatus

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

Role String Yes AliyunDDoSCOODefaultRole

The role that is used to check. Set the value to AliyunDDoSCOODefaultRole, which indicates the default role of Anti-DDoS Pro or Anti-DDoS Premium.

Note Anti-DDoS Pro or Anti-DDoS Premium uses the default role to access other cloud services.
RegionId String No cn-hangzhou

The region ID of the instance. Valid values:

  • cn-hangzhou: mainland China, which indicates an Anti-DDoS Pro instance
  • ap-southeast-1: outside mainland China, which indicates an Anti-DDoS Premium instance
ResourceGroupId String No default

The ID of the resource group to which the instance belongs in Resource Management. This parameter is empty by default, which indicates that the instance belongs to the default resource group.

Response parameters

Parameter Type Example Description
RequestId String 0bcf28g5-d57c-11e7-9bs0-d89d6717dxbc

The ID of the request.
StsGrant STRUCT

The authorization status of Anti-DDoS Pro or Anti-DDoS Premium.
Status Integer 1

Indicates whether Anti-DDoS Pro or Anti-DDoS Premium is authorized to access other cloud services. Valid values:

  • 0: not authorized
  • 1: authorized

Examples

Sample requests

http(s)://[Endpoint]/? Action=DescribeStsGrantStatus
&Role=AliyunDDoSCOODefaultRole
&<Common request parameters>

Sample success responses

XML format 

<? xml version="1.0" encoding="UTF-8" ? >
<DescribeStsGrantStatus
	<RequestId>0bcf28g5-d57c-11e7-9bs0-d89d6717dxbc</RequestId>
	<StsGrant>
		<Status>1</Status>
	</StsGrant>
</DescribeStsGrantStatus

JSON format 

{
    "RequestId": "0bcf28g5-d57c-11e7-9bs0-d89d6717dxbc",
    "StsGrant": {
        "Status": 1
    }
}

Error codes

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