DescribeStsGrantStatus - Anti-DDoS - Alibaba Cloud Documentation Center

Queries whether Anti-DDoS Proxy are authorized to access other cloud services.

Operation description

This operation queries whether your Alibaba Cloud account has authorized Anti-DDoS Pro and Anti-DDoS Premium to access other cloud services.

QPS limits

The maximum number of queries per second (QPS) for this operation is 10 per user. If the number of API calls exceeds this limit, throttling is triggered. This may affect your business operations. Ensure that you call this operation at an appropriate rate.

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

yundun-ddoscoo:DescribeStsGrantStatus

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ResourceGroupId	string	No	The ID of the resource group to which the Anti-DDoS Proxy instance belongs in Resource Management. If you do not specify this parameter, the default resource group is used.	rg-acfm2pz25js****
Role	string	Yes	The name of the RAM role that you want to query. The value is fixed as AliyunDDoSCOODefaultRole, which indicates the default role of Anti-DDoS Proxy. Note Anti-DDoS Proxy use this role by default to access your resources in other cloud services.	AliyunDDoSCOODefaultRole

When you call this operation, in addition to the request parameters described in this topic, you must also specify the common request parameters of Alibaba Cloud API. For more information, see Common parameters.

For the request format, see the "Examples" section of this topic.

Response elements

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	6623EA1F-30FB-5BC8-BEC9-74D55F6F08F1
StsGrant	object	The authorization status of Anti-DDoS Pro and Anti-DDoS Premium.
Status	integer	The authorization status. Valid values: 0: Anti-DDoS Proxy are not authorized to access resources of other cloud services. 1: Anti-DDoS Proxy are authorized to access resources of other cloud services.	1

Examples

Success response

JSON format

{
  "RequestId": "6623EA1F-30FB-5BC8-BEC9-74D55F6F08F1",
  "StsGrant": {
    "Status": 1
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.