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

Querying ECS Specifications

Function

This API is used to query ECS specifications.

URI

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

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

specification

Array of EcsSpecificationBean objects

ECS specifications set
Table 4 EcsSpecificationBean

Parameter

Type

Description

azs

Array of strings

Az information list

id

String

ECS specification ID

level

String

Level. [low,medium,high]

name

String

Name. ECS Type name.

proxy

Integer

Proxy

Database audit editions Basic:3

Database audit editions Professional:6

Database audit editions Advanced:30

ram

Integer

Memory

vcpus

Integer

CPU

azType

String

Retrun : [null]. There's meaningless at the moment

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

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

Example Responses

Status code: 200

Success

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

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