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

Querying Project Tags

Function

This API is used to query project tags.

URI

GET /v1/{project_id}/{resource_type}/tags

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

resource_type

Yes

String

Resource type.Default usage: auditInstance

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

tags

Array of tags objects

Tag list
Table 4 tags

Parameter

Type

Description

key

String

Key. The value can contain up to 128 characters.The key must comply with the 3.1 KEY character set specifications.

values

Array of strings

Value list. Enter a maximum of 255 characters.The value must comply with specifications described in 3.2 Character Set Specifications for VALUE.

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}/{resource_type}/tags

Example Responses

Status code: 200

Success

{
  "tags" : [ {
    "key" : "key1",
    "values" : [ "value1", "value2" ]
  }, {
    "key" : "key2",
    "values" : [ "value1", "value2" ]
  } ]
}

Status code: 400

Failure

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

Status Codes

Status Code

Description

200

Success

400

Failure

403

Authentication failed.

500

Server error.

Error Codes

See Error Codes.

Parent topic: Tag APIs