Help Center/ NAT Gateway/ API Reference (Ankara Region)/ Private Nat API/ Private NAT Gateway Tags/ Querying Tags of All Private NAT Gateways in a Project
Updated on 2024-04-19 GMT+08:00

Querying Tags of All Private NAT Gateways in a Project

Function

  • This API is used to query tags of all private NAT gateways owned by a tenant in a specified project.

  • TMS uses this API to list tags of all private NAT gateways owned by a tenant, and provide tag association when you tag or filter private NAT gateways.

Calling Method

For details, see Calling APIs.

URI

GET /v3/{project_id}/private-nat-gateways/tags

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID.

Minimum: 1

Maximum: 32

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the token of a user. It is a response to the API used to obtain the token of a user. This API is the only one that does not require authentication. The value of X-Subject-Token in the response header is the token.

Minimum: 1

Maximum: 10240

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

request_id

String

Specifies the request ID.

Minimum: 1

Maximum: 36

tags

Array of Tags objects

Tags

Array Length: 1 - 10

Table 4 Tags

Parameter

Type

Description

key

String

Specifies the operation to perform, which can only be filter (filtering) or count (querying the total number).filter indicates pagination query. count indicates that the total number of query results meeting the search criteria will be returned.

Minimum: 1

Maximum: 128

values

Array of strings

Specifies any tag that is included. Each tag can contain a maximum of 10 keys, and each key can contain a maximum of 10 values. The structure body cannot be missing, and the key cannot be left blank or set to an empty string. Keys must be unique and values of a key must be unique. Resources identified by different keys are in OR relationship, and values in one tag are in OR relationship. If no filtering condition is specified, full data is returned.

Minimum: 0

Maximum: 255

Example Requests

GET  https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/private-nat-gateways/tags

Example Responses

Status code: 200

Query operation succeeded.

{
  "request_id" : "c285190c-b9e9-4f38-a69a-6745f22d8dca",
  "tags" : [ {
    "key" : "keys",
    "values" : [ "value" ]
  }, {
    "key" : "key3",
    "values" : [ "value3", "value33" ]
  }, {
    "key" : "key1",
    "values" : [ "value1" ]
  }, {
    "key" : "key2",
    "values" : [ "value2", "value22" ]
  } ]
}

Status Codes

Status Code

Description

200

Query operation succeeded.

Error Codes

See Error Codes.