Help Center/ Database Security Service/ API Reference (Paris and Amsterdam Regions)/ API/ Management APIs/ Querying AZ Information
Updated on 2024-01-15 GMT+08:00
View PDF
Share

Querying AZ Information

Function

This API is used to query AZ information.

URI

GET /v2/{project_id}/dbss/audit/availability-zone

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

azs

Array of AzInfo objects

List of available zone information
Table 4 AzInfo

Parameter

Type

Description

zone_name

String

available zone name

zone_number

Integer

available zone number

az_type

String

available zone type

alias

String

available zone alias

alias_us

String

available zone alias in English

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error

Object

Error message.
Table 6 ErrorDetail

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error information.

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error

Object

Error message.
Table 8 ErrorDetail

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error information.

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error

Object

Error message.
Table 10 ErrorDetail

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error information.

Example Requests

/v2/{project_id}/dbss/audit/availability-zone

Example Responses

Status code: 200

Success

{
  "azs" : [ {
    "zone_name" : "region-01-7a",
    "zone_number" : 2,
    "az_type" : "normal",
    "alias" : "AZ 2",
    "alias_us" : "AZ2"
  }, {
    "zone_name" : "region-01-7b",
    "zone_number" : 1,
    "az_type" : "normal",
    "alias" : "AZ 1",
    "alias_us" : "AZ1"
  }, {
    "zone_name" : "region-01-7c",
    "zone_number" : 3,
    "az_type" : "normal",
    "alias" : "AZ3",
    "alias_us" : "AZ3"
  } ]
}

Status code: 400

Client error.

{
  "error" : {
    "error_code" : "DBSS.XXXX",
    "error_msg" : "XXX"
  }
}

Status Codes

Status Code

Description

200

Success

400

Client error.

403

Authentication failed.

500

Server error.

Error Codes

See Error Codes.

Parent topic: Management APIs