DescribeDdosCredit - Anti-DDoS - Alibaba Cloud Documentation Center

Operation description

You can call the DescribeDdosCredit operation to query the details of the security credit score of the current Alibaba Cloud account in a specific region. The details include the security credit score, security credit level, and the time period after which blackhole filtering is automatically deactivated.

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.

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-ddos:DescribeDdosCredit

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DdosRegionId	string	Yes	The ID of the region. Note You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object
Success	boolean	Indicates whether the request was successful. Valid values: true: yes false: no	true
RequestId	string	The ID of the request.	E1F7BD73-8E9D-58D9-8658-CFC97112C641
DdosCredit	object	The details of the security credit score of the current Alibaba Cloud account in the specified region.
Score	integer	The security credit score. The full score is 1000.	550
ScoreLevel	string	The security credit level. Valid values: A: outstanding B: excellent C: good D: average E: poor F: poorer	D
BlackholeTime	integer	The time period after which blackhole filtering is automatically deactivated in the specified region. Unit: minutes.	150

Examples

Success response

JSON format

{
  "Success": true,
  "RequestId": "E1F7BD73-8E9D-58D9-8658-CFC97112C641",
  "DdosCredit": {
    "Score": 550,
    "ScoreLevel": "D",
    "BlackholeTime": 150
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.