Querying Tags of a Private NAT Gateway

Function

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

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

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:privateNatGateways:listTags	List	privateGateway	g:ResourceTag/<tag-key> g:EnterpriseProjectId	nat:privateNatGatewayTags:list	-

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID.
resource_id	Yes	String	Specifies the private 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 value.

Response Parameters

Status code: 200

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

**Table 4** Tag
Parameter	Type	Description
key	String	Specifies the tag key. A key can contain up to 128 Unicode characters. key cannot be left blank.
value	String	Specifies the tag value. Each value can contain up to 255 Unicode characters.

Example Requests

GET  https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/private-nat-gateways/b0399473-c352-4d0c-8ff4-cfde719cfde9/tags

Example Responses

Status code: 200

Query operation succeeded.

{
  "request_id" : "80ef5f21-b81a-4546-b23d-84272507d330",
  "tags" : [ {
    "key" : "key1",
    "value" : "value1"
  }, {
    "key" : "key2",
    "value" : "value2"
  }, {
    "key" : "key3",
    "value" : "value3"
  } ]
}