Updated on 2024-04-19 GMT+08:00

Querying Tags of a Public NAT Gateway

Function

  • This API is used to query tags of a public NAT gateway.

  • TMS uses this API to query all tags of a public NAT gateway.

Constraints

  • You need to add the VPC domain name when calling the API for managing public NAT gateway tags.

Calling Method

For details, see Calling APIs.

URI

GET /v2.0/{project_id}/nat_gateways/{nat_gateway_id}/tags

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID.

nat_gateway_id

Yes

String

Specifies the public NAT gateway 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.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

tags

Array of TagBody objects

Specifies the tag list.

Table 4 TagBody

Parameter

Type

Description

key

String

Specifies the tag key. A key can contain up to 128 Unicode characters. key cannot be left blank. A key cannot contain ASCII characters (0–31 decimal) nor the following characters:=*<>,|/

value

String

Specifies the tag value. Each value can contain up to 255 Unicode characters and can be an empty string. A value cannot contain ASCII characters (0–31 decimal) nor the following characters:=*<>,|/

Example Requests

GET  https://{VPC_endpoint}/v2.0/9ad601814ac94c80bf7bb9073ded66fc/nat_gateways/fe1a4cf0-27fe-4b97-a9b1-2c67c127f0e0/tags

Example Responses

Status code: 200

Query operation succeeded.

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

Status Codes

Status Code

Description

200

Query operation succeeded.

Error Codes

See Error Codes.