Querying Backup Policies by Tag¶
Function¶
This API is used to query backup policies by tag.
URI¶
URI format
POST /v2/{project_id}/backuppolicy/resource_instances/action
Parameter description
Parameter
Mandatory
Description
project_id
Yes
Project ID
Request¶
Parameter description
Parameter
Mandatory
Type
Description
tags
No
list<dict>
List of tags. Backup policies with these tags will be filtered. This list can have a maximum of 10 tags.
key
Yes
string
Tag key. Tag keys must be unique.
values
Yes
list<string>
List of tag values. This list can have a maximum of 10 tag values and these values must be unique.
tags_any
No
list<dict>
List of tags. Backups with any tags in this list will be filtered.
This list cannot be an empty list.
The list can contain up to 10 keys.
Keys in this list must be unique.
The response returns resources containing any tags in this list. Keys in this list are in an OR relationship while values in each key-value structure is in an OR relationship.
key
Yes
string
Tag key
values
Yes
list<string>
List of tag values
not_tags
No
list<dict>
List of excluded tags. Backups without these tags will be filtered.
This list cannot be an empty list.
The list can contain up to 10 keys.
Keys in this list must be unique.
The response returns resources containing no tags in this list. Keys in this list are in an AND relationship while values in each key-value structure is in an OR relationship.
key
Yes
string
Tag key
values
Yes
list<string>
List of tag values
not_tags_any
No
list<dict>
List of tags. Backups without any tags in this list will be filtered.
This list cannot be an empty list.
The list can contain up to 10 keys.
Keys in this list must be unique.
The response returns resources without any tags in this list. Keys in this list are in an OR relationship while values in each key-value structure is in an OR relationship.
key
Yes
string
Tag key
values
Yes
list<string>
List of tag values
matches
No
list<dict>
Search criteria. Fuzzy search is supported.
key
Yes
string
Field for searching. Currently, only resource_name is supported.
value
Yes
string
Search value
limit
No
string
Number of queried records. This parameter is not displayed if action is set to count. The default value is 1000 if action is set to filter. The value must be an integer ranging from 1000.
offset
No
string
Query index. (This parameter is not displayed if action is set to count.) The query starts from the next piece of data indexed by this parameter. If action is set to filter, the default value is 0 which indicates the query starts from the first piece of data. The value must be a non-negative integer.
action
Yes
string
Operator. Possible values are:
filter: queries backup policies by specifying filtering conditions.
count: queries backup policies by specifying the total number.
Example request
{ "limit": "10", "offset": "0", "tags": [ { "key": "Tag001", "values":["Value001","Value002"] } ], "action":"filter" }
Response¶
Parameter description
Parameter
Type
Description
total_count
integer
Total number of resources
resources
list<dict>
List of resources
resource_id
string
Resource ID
resouce_detail
object
Resource details, used for extension
resource_name
string
Resource name
tags
list<dict>
List of tags
key
string
Tag key
value
string
Tag value
message
string
Error message returned after an error occurs
code
string
Error code returned after an error occurs
For details about error codes, see Error Codes.
Example response
{ "total_count":10, "resources":[ { "resource_name": "name", "resource_id": "0781095c-b8ab-4ce5-99f3-4c5f6ff75319", "resource_detail": null, "tags": [{ "key":"key", "value":"value" }] } ] }
or
{ "error": { "message": "XXXX", "code": "XXX" } }
Status Codes¶
Normal
200
Abnormal
Status Code
Description
400 Bad Request
The server failed to process the request.
401 Unauthorized
You must enter the username and password to access the requested page.
403 Forbidden
You are forbidden to access the requested page.
404 Not Found
The server could not find the requested page.
405 Method Not Allowed
You are not allowed to use the method specified in the request.
406 Not Acceptable
The response generated by the server could not be accepted by the client.
407 Proxy Authentication Required
You must use the proxy server for authentication so that the request can be processed.
408 Request Timeout
The request timed out.
409 Conflict
The request could not be processed due to a conflict.
500 Internal Server Error
Failed to complete the request because of an internal service error.
501 Not Implemented
Failed to complete the request because the server does not support the requested function.
502 Bad Gateway
Failed to complete the request because the request is invalid.
503 Service Unavailable
Failed to complete the request because the service is unavailable.
504 Gateway Timeout
A gateway timeout error occurred.
Error Codes¶
For details, see Error Codes.