Help Center/ NAT Gateway/ API Reference/ APIs for Public NAT Gateways/ Public NAT Gateway Tags (V3)/ Querying Tags of All Public NAT Gateways in a Project
Updated on 2026-03-19 GMT+08:00

Querying Tags of All Public NAT Gateways in a Project

Function

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

  • Tag Management Service (TMS) uses this API to list tags created by a tenant to ease tag creation and resource filtering on the console.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    nat:natGateways:listTags

    List

    gateway

    • g:ResourceTag/<tag-key>

    • g:EnterpriseProjectId

    nat:natGatewayTags:get

    -

URI

GET /v3/{project_id}/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

tags

Array of TagsBody objects

Specifies the tag list.

Table 4 TagsBody

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 non-printable ASCII characters (0–31) or the following special characters: *<>\=

values

Array of strings

Specifies the list of tag values. Each value can contain up to 255 Unicode characters and can be an empty string. Each value cannot contain non-printable ASCII characters (0–31) or the following special characters: *<>\=

Example Requests

GET  https://{NAT_endpoint}/v3/9ad601814ac94c80bf7bb9073ded66fc/nat_gateways/tags

Example Responses

Status code: 200

Query operation succeeded.

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

Status Codes

Status Code

Description

200

Query operation succeeded.

Error Codes

See Error Codes.