Querying Private NAT Gateways

Function

This API is used to query private NAT gateways by tag.
TMS uses this API to query and list private NAT gateways by tag.

Calling Method

For details, see Calling APIs.

URI

POST /v3/{project_id}/private-nat-gateways/resource_instances/action

**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

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
offset	No	String	Specifies the index position. The query starts from the next data record indexed by this parameter. You do not need to specify this parameter when you query resources on the first page. When you query resources on subsequent pages, set this parameter to the value returned in the response body for the previous query. This parameter is not available when action is set to count. If action is set to filter, the value must be a positive number, and the default value is 0. Minimum: 0 Maximum: 65535
limit	No	String	Tags Minimum: 1 Maximum: 1000
action	Yes	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. Enumeration values: filter count
matches	No	Array of Match objects	Tags
not_tags	No	Array of Tags objects	Specifies details of a resource. This parameter is used for extension and is left blank by default. Array Length: 1 - 10
tags	No	Array of Tags objects	Specifies the tag key. Array Length: 1 - 10
tags_any	No	Array of Tags objects	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. Array Length: 1 - 10
not_tags_any	No	Array of Tags objects	Specifies any tag that is not 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 not 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. Array Length: 1 - 10

**Table 4** Match
Parameter	Mandatory	Type	Description
key	Yes	String	Specifies the tag key used to search resources. Minimum: 1 Maximum: 128
value	Yes	String	Specifies the tag value used to search resources. Minimum: 0 Maximum: 255

**Table 5** Tags
Parameter	Mandatory	Type	Description
key	Yes	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	Yes	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

Response Parameters

Status code: 200

**Table 6** Response body parameters
Parameter	Type	Description
resources	Array of Resource objects	Specifies the resource list. Array Length: 1 - 2000
request_id	String	Specifies the request ID. Minimum: 1 Maximum: 36
total_count	Integer	Specifies the total number of records.

**Table 7** Resource
Parameter	Type	Description
resource_detail	Object	Specifies details of a resource. This parameter is used for extension and is left blank by default.
resource_id	String	Specifies the resource ID. Minimum: 36 Maximum: 36
resource_name	String	Specifies the resource name. This parameter is an empty string by default if there is no resource name. Minimum: 0 Maximum: 36
resource_tag	Array of ResourceTag objects	Specifies the list of queried tags. If no tag is matched, an empty array is returned. Array Length: 1 - 10

**Table 8** ResourceTag
Parameter	Type	Description
key	String	Specifies the tag key. Minimum: 1 Maximum: 128
value	String	Specifies the tag value. Minimum: 0 Maximum: 255

Example Requests

Querying public NAT gateways by tag (Setting action to filter and limit to 10)

POST  https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/private-nat-gateways/resource_instances/action

{
  "offset" : "10",
  "limit" : "10",
  "action" : "filter",
  "matches" : [ {
    "key" : "resource_name",
    "value" : "resource1"
  } ],
  "not_tags" : [ {
    "key" : "key1",
    "values" : [ "*value1", "value2" ]
  } ],
  "tags" : [ {
    "key" : "key1",
    "values" : [ "*value1", "value2" ]
  } ],
  "tags_any" : [ {
    "key" : "key1",
    "values" : [ "value1", "value2" ]
  } ],
  "not_tags_any" : [ {
    "key" : "key1",
    "values" : [ "value1", "value2" ]
  } ]
}

Querying private NAT gateways by tag (Setting action to count and adding tags)

POST  https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/private-nat-gateways/resource_instances/action

{
  "action" : "count",
  "not_tags" : [ {
    "key" : "key1",
    "values" : [ "value1", "*value2" ]
  } ],
  "tags" : [ {
    "key" : "key1",
    "values" : [ "value1", "value2" ]
  }, {
    "key" : "key2",
    "values" : [ "value1", "value2" ]
  } ],
  "tags_any" : [ {
    "key" : "key1",
    "values" : [ "value1", "value2" ]
  } ],
  "not_tags_any" : [ {
    "key" : "key1",
    "values" : [ "value1", "value2" ]
  } ],
  "matches" : [ {
    "key" : "resource_name",
    "value" : "resource1"
  } ]
}

Example Responses

Status code: 200

Query operation succeeded.
Example 1: the response body when action is set to count
Example 2: the response body when action is set to filter

Example 1

{
  "request_id" : "a67262f6b7242d63d4ae95e41abf2790",
  "total_count" : 100
}

Example 2

{
  "resources" : [ {
    "resource_detail" : null,
    "resource_id" : "e5ad289f-9c56-4daf-b08b-2e53a983473a",
    "resource_name" : "nat_gateways",
    "tags" : [ {
      "key" : "key1",
      "value" : "value1"
    }, {
      "key" : "key2",
      "value" : "value1"
    } ]
  } ],
  "request_id" : "a67262f6b7242d63d4ae95e41abf2790",
  "total_count" : 1
}