Querying Transit IP Addresses
Function
This API is used to query transit IP addresses by tag.
TMS uses this API to query and list transit IP addresses by tag.
Debugging
You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.
URI
POST /v3/{project_id}/transit-ips/resource_instances/action
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Specifies the project ID. Minimum: 1 Maximum: 32 |
Request 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 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
offset |
No |
String |
Specifies the request ID. 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:
|
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. |
tags |
No |
Array of Tags objects |
Specifies the tag key. |
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. |
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. |
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 |
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
Parameter |
Type |
Description |
---|---|---|
resources |
Array of Resource objects |
Specifies the resource list. |
request_id |
String |
Specifies the request ID. Minimum: 1 Maximum: 36 |
total_count |
Integer |
Specifies the total number of records. |
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. |
Example Requests
The request body when action is set to filter
POST https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/transit-ips/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" ] } ] }
The request body when action is set to count
POST https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/transit-ips/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" : "d70aabc854d3d301f9bb106e6b70ac99", "total_count" : 100 }
Example 2
{ "resources" : [ { "resource_detail" : null, "resource_id" : "ae33be9b-d2c0-441b-a8d0-f6dafedf1778", "resource_name" : "transit_ips", "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value1" } ] } ], "request_id" : "9e47d9476cfd346f864cb77acb274185", "total_count" : 1 }
Status Codes
Status Code |
Description |
---|---|
200 |
|
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.