Querying Tags of All Public NAT Gateways in a Project
Function
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.
URI
GET /v3/{project_id}/nat_gateways/tags
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Specifies the project ID. |
Request 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
|
Parameter |
Type |
Description |
|---|---|---|
|
tags |
Array of TagsBody objects |
Specifies the tag list. |
|
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.