All Products
Search
Document Center

Database Backup:DescribeRegions

Last Updated:Sep 16, 2022

Queries the regions that Database Backup (DBS) supports.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • 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 keyword: refers to the condition keyword defined by the cloud product itself.
  • 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.
Operateaccess levelResource typeconditional keywordAssociation operation
dbs:DescribeRegionsRead
      without
    without

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ClientTokenstringNo

    The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that the value is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

    ETnLKlblzczshOTUbOCzxxxxxxxxxx

    Response parameters

    ParameterTypeDescriptionExample
    object
    HttpStatusCodeinteger

    The HTTP status code.

    400
    RequestIdstring

    The ID of the request.

    EB4DFD5E-3618-498D-BE35-4DBEA0072122
    ErrCodestring

    The error code.

    InvalidParameter
    Successboolean

    Indicates whether the request is successful.

    true
    ErrMessagestring

    The error message.

    This backupPlan can't support this action
    Regionsarray
    string

    The regions that DBS supports.

    cn-hangzhou

    Example

    Request example

    http(s)://dbs-api.cn-hangzhou.aliyuncs.com/?Action=DescribeRegions
    &<Common request parameters>
    

    Normal return example

    JSONFormat

    {
        "DescribeRegionsResponse": {
            "RequestId": "EB4DFD5E-3618-498D-BE35-4DBEA0072122",
            "HttpStatusCode": 400,
            "Regions": {
                "RegionCode": ""
            },
            "ErrMessage": "This backupPlan can't support this action",
            "Success": true,
            "ErrCode": "InvalidParameter"
        }
    }

    XMLFormat

    <DescribeRegionsResponse>
        <RequestId>EB4DFD5E-3618-498D-BE35-4DBEA0072122</RequestId>
        <HttpStatusCode>400</HttpStatusCode>
        <Regions>
            <RegionCode/>
        </Regions>
        <ErrMessage>This backupPlan can't support this action</ErrMessage>
        <Success>true</Success>
        <ErrCode>InvalidParameter</ErrCode>
    </DescribeRegionsResponse>

    Error codes

    For a list of error codes, visit the API error center.