All Products
Search
Document Center

Anti-DDoS:DescribeRegions

Last Updated:Apr 10, 2024

Queries the regions of cloud assets that are supported by an Anti-DDoS Origin instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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
yundun-antiddosbag:DescribeRegionsRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ResourceGroupIdstringNo

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

For more information about resource groups, see Create a resource group.

rg-acfm2pz25js****
RegionIdstringNo

The region ID to query. The default value is cn-hangzhou, which indicates that the regions of cloud assets that are supported by an Anti-DDoS Origin instance in the China (Hangzhou) region are queried.

For more information about the IDs of other regions, see Regions and zones.

cn-hangzhou

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

ParameterTypeDescriptionExample
object
Codestring

The HTTP status code.

200
RequestIdstring

The ID of the request.

F7CA8B4E-FB15-4336-A351-8DC29D66EA82
Successboolean

Indicates whether the request is successful. Valid values:

  • true: The request is successful.
  • false: The request failed.
true
Regionsobject []

The information about regions of the cloud assets that are supported by the Anti-DDoS Origin instance. The information includes region IDs and names.

RegionEnNamestring

The English name of the region where the cloud assets reside.

China (Hangzhou)
RegionNamestring

The name of the region where the cloud assets reside.

RegionIdstring

The ID of the region.

cn-hangzhou

Examples

Sample success responses

JSONformat

{
  "Code": "200",
  "RequestId": "F7CA8B4E-FB15-4336-A351-8DC29D66EA82",
  "Success": true,
  "Regions": [
    {
      "RegionEnName": "China (Hangzhou)",
      "RegionName": "",
      "RegionId": "cn-hangzhou"
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.