All Products
Search
Document Center

CloudOps Orchestration Service:DescribeRegions

Last Updated:Oct 14, 2024

Queries supported regions.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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
oos:DescribeRegionsget
  • All Resources
    *
    none
none

Request syntax

POST /DescribeRegions HTTP/1.1 GET /DescribeRegions HTTP/1.1

POST /DescribeRegions HTTP/1.1 GET /DescribeRegions HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The region ID.

cn-hangzhou
AcceptLanguagestringNo

The supported natural language. Valid values:

  • zh-CN: Chinese
  • en-US: English
zh-CN

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

469E79B1-90A3-4A57-B7C4-2FE0C8B5175E
Regionsarray<object>

The details of the regions.

Regionobject
RegionEndpointstring

The endpoint of the region.

oos.cn-shenzhen.aliyuncs.com
LocalNamestring

The name of the region.

China (Shenzhen)
RegionIdstring

The region ID.

cn-shenzhen

Examples

Sample success responses

JSONformat

{
  "RequestId": "469E79B1-90A3-4A57-B7C4-2FE0C8B5175E",
  "Regions": [
    {
      "RegionEndpoint": "oos.cn-shenzhen.aliyuncs.com",
      "LocalName": "China (Shenzhen)",
      "RegionId": "cn-shenzhen"
    }
  ]
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-05-08The internal configuration of the API is changed, but the call is not affectedView Change Details