All Products
Search
Document Center

SchedulerX:DescribeRegions

Last Updated:Dec 10, 2024

Returns available 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

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The region ID.

cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object
Codeinteger

The HTTP status code.

200
Messagestring

The error message that was returned only if the corresponding error occurred.

disable failed jobs=[99341]
RequestIdstring

The ID of the request.

4F68ABED-AC31-4412-9297-D9A8F0401108
Successboolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true
Regionsarray<object>

The available regions.

Regionobject
RegionEndpointstring

The endpoint of the region.

schedulerx.cn-hangzhou.aliyuncs.com
LocalNamestring

The display name of the region, which varies based on the current language.

China (Hangzhou)
RegionIdstring

The ID of the region.

cn-hangzhou

Examples

Sample success responses

JSONformat

{
  "Code": 200,
  "Message": "disable failed jobs=[99341]",
  "RequestId": "4F68ABED-AC31-4412-9297-D9A8F0401108",
  "Success": true,
  "Regions": [
    {
      "RegionEndpoint": "schedulerx.cn-hangzhou.aliyuncs.com",
      "LocalName": "China (Hangzhou)\n",
      "RegionId": "cn-hangzhou"
    }
  ]
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-05-30The request parameters of the API has changedView Change Details