project_id

Yes

String

Project ID

without_any_tag

No

Boolean

If this parameter is set to true, all resources without tags are queried. In this case, the tag, not_tags, tags_any, and not_tags_any fields are ignored.

tags

No

Array of TagsReq objects

List of included tags. Backups with 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 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.

If no tag filtering condition is specified, full data is returned.

tags_any

No

Array of TagsReq objects

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.

If no tag filtering condition is specified, full data is returned.

not_tags

No

Array of TagsReq objects

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.

If no tag filtering condition is specified, full data is returned.

not_tags_any

No

Array of TagsReq objects

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.

If no tag filtering condition is specified, full data is returned.

sys_tags

No

Array of SysTags objects

Only users with the op_service permission can use this field to filter resources.

Currently, TMS can only invoke the following one tag structure.

key: _sys_enterprise_project_id

values: List of enterprise project IDs

Currently, key contains only one value. 0 indicates the default enterprise project.

sys_tags and tenant tag filtering conditions (tags, tags_any, not_tags, and not_tags_any) cannot be used at the same time.

If no sys_tags exists, filter with other tag interfaces. If no tag filtering condition is specified, full data is returned.

This list cannot be an empty list.

limit

No

String

Query count. (This parameter is not displayed when action is set to count.) If action is set to filter, the value defaults to 1000. The value ranges from 1 to 1000. If you set a value not within this range, an error will be reported. The number of returned records does not exceed the value of limit.

offset

No

String

Index position. (This parameter is not displayed when action is set to count.) If action is set to filter, the value defaults to 0 and the minimum value of offset is 0. The first record in the query result is the offset+1 record that meets the query criteria.

action

Yes

String

Operation identifier. Possible values are filter and count. The value filter indicates pagination query. The value count indicates that the total number of query results meeting the search criteria will be returned.

matches

No

Array of Match objects

List of query criteria supported by resources.

This list cannot be an empty list.

Keys in this list must be unique.

cloud_type

No

String

Cloud type

Enumeration values:

• public

• hybrid

object_type

No

String

Resource type

Enumeration values:

• server

• disk

key

Yes

String

Key.

It contains a maximum of 127 Unicode characters.

A tag key cannot be an empty string.

Spaces before and after a key will be deprecated.

values

Yes

Array of strings

List of values.

The list can contain up to 10 values.

A tag value contains up to 255 Unicode characters. Spaces before and after a key will be deprecated.

Values in this list must be unique.

Values in this list are in an OR relationship.

This list can be empty and each value can be an empty character string.

If this list is left blank, it indicates that all values are included. The asterisk (*) is a reserved character in the system. If the value starts with *, it indicates that fuzzy match is performed based on the value following *. The value cannot contain only asterisks.

key

Yes

String

Key. Key of the system tag, which is obtained from the whitelist and cannot be defined randomly. Currently, only the _sys_enterprise_project_id field is supported, and the corresponding value is the enterprise project ID.

values

Yes

Array of strings

List of values. Currently, only the enterprise project ID is used. The default enterprise project ID is 0.

key

Yes

String

Key. A key can only be set to resource_name, indicating the resource name.

value

Yes

String

Value. A value consists of up to 255 characters. If key is set to resource_name, an empty character string indicates exact matching and any non-empty string indicates fuzzy matching.

resources

Array of TagResource objects

List of matched resources (This parameter is not displayed if action is set to count.)

total_count

Integer

Total number of matched resources

resource_id

String

Resource ID

resource_detail

Array of Vault objects

Resource details

tags

Array of Tag objects

Tag list.

If there is no tag, an empty array is used by default.

resource_name

String

Resource name

sys_tags

Array of SysTag objects

Only users with the op_service permission can obtain this field.

Currently, only one structure resource_tag is used.

key: _sys_enterprise_project_id

value: enterprise project ID. The value 0 indicates the default enterprise project.

This field cannot be returned in the non-op_service scenario.

billing

Billing object

Operation info

description

String

User-defined vault description

Minimum: 0

Maximum: 255

id

String

Vault ID

name

String

Vault name

Minimum: 1

Maximum: 64

project_id

String

Project ID

provider_id

String

Vault type

resources

Array of ResourceResp objects

Vault resources

tags

Array of Tag objects

Vault tags

enterprise_project_id

String

Enterprise project ID. The default value is 0.

auto_bind

Boolean

Specifies whether automatic association is enabled. The default value is false, indicating that automatic association is disabled.

bind_rules

VaultBindRules object

Association rule

user_id

String

User ID

created_at

String

Creation time, such as 2020-02-05T10:38:34.209782

auto_expand

Boolean

Whether to enable auto capacity expansion for the vault. Only pay-per-use vaults support this function.

allocated

Integer

Allocated capacity, in MB.

charging_mode

String

Creation mode

Enumeration values:

• pre_paid

• post_paid

cloud_type

String

Cloud platform

Enumeration values:

• public

• hybrid

consistent_level

String

Backup specifications

object_type

String

Object type. Possible values are server (cloud servers), disk (EVS disks), and turbo (SFS Turbo file systems).

order_id

String

Order ID

product_id

String

Product ID

protect_type

String

Protection type

Enumeration values:

• backup

• replication

• hybrid

size

Integer

Capacity, in GB

Minimum: 1

Maximum: 10485760

spec_code

String

Specification code

Enumeration values:

• vault.backup.server.normal

• vault.backup.volume.normal

status

String

Vault status

Enumeration values:

• available

• lock

• frozen

• deleting

• error

storage_unit

String

Name of the bucket for the vault

used

Integer

Used capacity, in MB.

frozen_scene

String

Scenario when an account is frozen

extra_info

ResourceExtraInfo object

Extra information of the resource

id

String

ID of the resource to be backed up

name

String

Name of the resource to be backed up

Minimum: 0

Maximum: 255

protect_status

String

Protection status

Enumeration values:

• available

• error

• protecting

• restoring

• removing

size

Integer

Allocated capacity for the associated resource, in GB

type

String

Type of the resource to be backed up. Possible values are as follows: OS::Nova::Server, OS::Cinder::Volume, OS::Ironic::BareMetalServer, OS::Native::Server, and OS::Sfs::Turbo

backup_size

Integer

Backup size

backup_count

Integer

Number of backups

exclude_volumes

Array of strings

ID of the disk that is excluded from the backup. This parameter is used only when there are VM disk backups.

include_volumes

Array of ResourceExtraInfoIncludeVolumes objects

Disk to be backed up

id

String

EVS disk ID. Only UUID is supported.

os_version

String

OS type

tags

Array of Tag objects

Filters automatically associated resources by tag.

key

String

Key.

It consists of up to 36 characters.

It cannot be an empty string.

Spaces before and after a key will be deprecated.

It cannot contain ASCII (0-31) or the following characters: =*<>,|/

It can contain only Chinese characters, letters, digits, hyphens, and underscores.

value

String

Value.

The value of this parameter is mandatory when a tag is added and optional when a tag is deleted.

It consists of up to 43 characters.

It can be an empty string.

Spaces before and after a value will be deprecated.

It cannot contain ASCII (0-31) or the following characters: =*<>,|/

It can contain only Chinese characters, letters, digits, hyphens, and underscores.

key

String

Key. Key of the system tag, which is obtained from the whitelist and cannot be defined randomly. Currently, only the _sys_enterprise_project_id field is supported, and the corresponding value indicates the enterprise project ID.

value

String

Value. Currently, only the enterprise project ID is used. The default enterprise project ID is 0.

error_code

String

For details, see Error Codes.

error_msg

String

Error message

200

OK

400

Bad Request