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 project.
TMS uses this API to list tags of all private NAT gateways owned by a tenant, and provides 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.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies the user token. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. The value of X-Subject-Token in the response header is the token value.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
request_id	String	Specifies the request ID.
tags	Array of Tags objects	Specifies the tags.

**Table 4** Tags
Parameter	Type	Description
key	String	Specifies the tag key. A key can contain up to 128 Unicode characters. (The system does not verify key when searching for resources.) key cannot be left blank or be an empty string. key cannot contain spaces. Before using the value of key, delete spaces before and after the value.
values	Array of strings	Lists tag values. Each value can contain a maximum of 255 Unicode characters. Before verifying and using values, delete single-byte character spaces before and after each value. The value can be an empty array but cannot be left blank. If values is an empty array, any value can be queried. The values are in the OR relationship. The system verifies the length, but not the character set of this parameter when searching for resources.

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" ]
  }, {
    "key" : "key1",
    "values" : [ "value1" ]
  }, {
    "key" : "key2",
    "values" : [ "value2" ]
  } ]
}