Help Center/ Database Security Service/ API Reference/ API/ Querying on the Management Side/ Querying ECS Specifications
Updated on 2025-06-19 GMT+08:00
View PDF

Querying ECS Specifications

Function

This API is used to query ECS specifications.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/dbss/audit/specification

Table 1 URI parameter

Parameter

Mandatory

Parameter Type

Description

project_id

Yes

String

Project ID.

Request Parameter

Table 2 Request header parameter

Parameter

Mandatory

Parameter Type

Description

X-Auth-Token

Yes

String

User token. The token can be queried by calling the IAM API. (The token is the value of X-Subject-Token in the response header.)

Response Parameters

Status code: 200

Table 3 Response body parameter

Parameter

Parameter Type

Description

specification

Array of EcsSpecificationBean objects

Specifies a set of specifications.
Table 4 EcsSpecificationBean

Parameter

Parameter Type

Description

azs

Array of strings

AZ set to which the ECS specification belongs

id

String

ECS specification ID

level

String

Specification level. The supported level depends on the site configuration.

  • entry: entry level
  • low: basic edition
  • medium: professional edition
  • high: advanced edition

name

String

Flavor name

proxy

Integer

Number of databases that can be added to the specification

ram

Integer

Memory

vcpus

Integer

VM CPU

az_type

String

AZ Type

  • DEDICATED
  • DEC
  • EDGE

Status code: 400

Table 5 Response body parameter

Parameter

Parameter Type

Description

error

Object

Error message.
Table 6 ErrorDetail

Parameter

Parameter Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 403

Table 7 Response body parameter

Parameter

Parameter Type

Description

error

Object

Error message.
Table 8 ErrorDetail

Parameter

Parameter Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 500

Table 9 Response body parameter

Parameter

Parameter Type

Description

error

Object

Error message.
Table 10 ErrorDetail

Parameter

Parameter Type

Description

error_code

String

Error code

error_msg

String

Error message

Example request

/v1/{project_id}/dbss/audit/specification

Example Response

Status code: 200

Succeeded

{
  "specification" : [ {
    "level" : "low",
    "id" : "s2.xlarge.4",
    "name" : "s2.xlarge.4",
    "vcpus" : 4,
    "ram" : 16384,
    "proxy" : 3,
    "azs" : [ "cn-cmcc1a-01" ]
  }, {
    "level" : "medium",
    "id" : "s2.2xlarge.4",
    "name" : "s2.2xlarge.4",
    "vcpus" : 8,
    "ram" : 32768,
    "proxy" : 6,
    "azs" : [ "cn-cmcc1a-01" ]
  }, {
    "level" : "high",
    "id" : "s3.4xlarge.4",
    "name" : "s3.4xlarge.4",
    "vcpus" : 16,
    "ram" : 65536,
    "proxy" : 30,
    "azs" : [ "cn-cmcc1a-01", "cn-cmcc1b-01" ]
  } ]
}

Status code: 400

Client errors

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

Status Code

Status Code

Description

200

Success

400

Client errors

403

Authentication failed.

500

Server error.

Error Codes

For details, see Error Codes.