You can use this API to add tags to multiple resources. Up to 10 tags can be added to a resource and a maximum of 50 resources can be tagged at a time.
+POST /v1.0/resource-tags/batch-create
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+Specifies the user token. TMS is a global service. So you need to set scope to domain when calling an IAM API to obtain a user token. The value of X-Subject-Token in the response header is the user token. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+No + |
+String + |
+Specifies the project ID. This parameter is mandatory when resource_type is at a region level. + |
+
resources + |
+Yes + |
+Array of ResourceTagBody objects + |
+Specifies resources. + |
+
tags + |
+Yes + |
+Array of CreateTagRequest objects + |
+Specifies tags. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
resource_id + |
+Yes + |
+String + |
+Specifies the resource ID. + |
+
resource_type + |
+Yes + |
+String + |
+Specifies the resource type. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
key + |
+Yes + |
+String + |
+Specifies the key. +It cannot be left blank and can contain a maximum of 36 Unicode characters. Only digits, letters, hyphens (-), at signs (@), and underscores (_) are allowed. + |
+
value + |
+Yes + |
+String + |
+Specifies the value. +Each value contains a maximum of 43 Unicode characters and can be an empty string. Only digits, letters, hyphens (-), at signs (@), and underscores (_) are allowed. + |
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
failed_resources + |
+Array of TagCreateResponseItem objects + |
+Specifies resources for which tags fail to be added. + |
+
You can use this API to batch tag resources.
+POST https://{Endpoint}/v1.0/resource-tags/batch-create
+
+{
+ "project_id" : "xxxdcffffffff",
+ "resources" : [ {
+ "resource_id" : "a28531fa-a8d5-468e-8417-86a80962ee5e",
+ "resource_type" : "disk"
+ }, {
+ "resource_id" : "a28531fa-a8d5-468e-8417-86a8096ddddd",
+ "resource_type" : "vpc"
+ } ],
+ "tags" : [ {
+ "key" : "ENV",
+ "value" : "dev"
+ }, {
+ "key" : "DEPT",
+ "value" : "pdd"
+ } ]
+}
+Status code: 200
+Successful operation
+{
+ "failed_resources": []
+}
+See Status Codes.
+See Error Codes.
+You can use this API to remove tags from multiple resources. Up to 10 tags can be removed from a resource and a maximum of 50 resources can be operated at a time.
+POST /v1.0/resource-tags/batch-delete
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+Specifies the user token. TMS is a global service. So you need to set scope to domain when calling an IAM API to obtain a user token. The value of X-Subject-Token in the response header is the user token. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+No + |
+String + |
+Specifies the project ID. This parameter is mandatory when resource_type is at a region level. + |
+
resources + |
+Yes + |
+Array of ResourceTagBody objects + |
+Specifies resource list + |
+
tags + |
+Yes + |
+Array of DeleteTagRequest objects + |
+Specifies tags. + |
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
failed_resources + |
+Array of TagDeleteResponseItem objects + |
+Specifies resources for which tags are failed to be deleted. + |
+
Batch delete tags
+POST https://{Endpoint}/v1.0/resource-tags/batch-delete
+
+{
+ "project_id" : "xxxdcffffffff",
+ "resources" : [ {
+ "resource_id" : "a28531fa-a8d5-468e-8417-86a80962ee5e",
+ "resource_type" : "disk"
+ }, {
+ "resource_id" : "vpc-dc7d19b7",
+ "resource_type" : "vpc"
+ } ],
+ "tags" : [ {
+ "key" : "ENV"
+ } ]
+}
+Status code: 200
+Successful operation
+{
+ "failed_resources": []
+}
+See Status Codes.
+See Error Codes.
+You can use this API to query tags of a specific resource.
+GET /v2.0/resources/{resource_id}/tags
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
resource_id + |
+Yes + |
+String + |
+Specifies the resource ID. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+No + |
+String + |
+Specifies the project ID. This parameter is mandatory for region-level resources. + |
+
resource_type + |
+Yes + |
+String + |
+Specifies the resource type. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+Specifies the user token. TMS is a global service. So you need to set scope to domain when calling an IAM API to obtain a user token. The value of X-Subject-Token in the response header is the user token. + |
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
tags + |
+Array of TagVo objects + |
+Specifies resource tags. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
key + |
+String + |
+Specifies the key. +It cannot be left blank and can contain a maximum of 36 Unicode characters. Only digits, letters, hyphens (-), at signs (@), and underscores (_) are allowed. + |
+
value + |
+String + |
+Specifies the value. +Each value contains a maximum of 43 Unicode characters and can be an empty string. Only digits, letters, hyphens (-), at signs (@), and underscores (_) are allowed. + |
+
Querying tags of a resource
+GET https://{Endpoint}/v2.0/resources/xxxx/tags?project_id=xxxx&resource_type=disk
+Status code: 200
+Successful operation
+{
+ "tags" : [ {
+ "key" : "key1",
+ "value" : "value1"
+ }, {
+ "key" : "key2",
+ "value" : "value2"
+ } ]
+}
+See Status Codes.
+See Error Codes.
+You can use this API to query services supported by TMS.
+GET /v1.0/tms/providers
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
locale + |
+No + |
+String + |
+Specifies the display language. + |
+
limit + |
+No + |
+Integer + |
+The maximum queries supported. The value 10 is used by default if this parameter is not set. The value range is 1 to 200. + |
+
offset + |
+No + |
+Integer + |
+Specifies the index position, which starts from the next data record specified by offset. The value must be a number and cannot be negative. The default value is 0. + |
+
provider + |
+No + |
+String + |
+Specifies the cloud service name. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+Specifies the user token. TMS is a global service. So you need to set scope to domain when calling an IAM API to obtain a user token. The value of X-Subject-Token in the response header is the user token. + |
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
providers + |
+Array of ProviderResponseBody objects + |
+Specifies the cloud services + |
+
total_count + |
+Integer + |
+Specifies the total cloud services supported. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
provider + |
+String + |
+Specifies the cloud service name. + |
+
provider_i18n_display_name + |
+String + |
+Specifies the display name of the resource. You can set the language by setting the **locale** parameter. + |
+
resource_types + |
+Array of ResourceTypeBody objects + |
+Specifies the resource type. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
resource_type + |
+String + |
+Specifies the resource type. + |
+
resource_type_i18n_display_name + |
+String + |
+Specifies the display name of the resource type. You can set the language by setting the **locale** parameter. + |
+
regions + |
+Array of strings + |
+Specifies the supported regions. + |
+
global + |
+Boolean + |
+Specifies whether the resource is a global resource. + |
+
Querying supported services by TMS
+GET https://{Endpoint}/v1.0/tms/providers?locale=en-us&limit=200
+Status code: 200
+Successful operation
+{
+ "providers": [
+ {
+ "provider": "drs",
+ "provider_i18n_display_name": "drs",
+ "resource_types": [
+ {
+ "global": false,
+ "resource_type": "sync",
+ "resource_type_i18n_display_name": "sync",
+ "regions": [
+ "eu-de"
+ ]
+ },
+ {
+ "global": false,
+ "resource_type": "cloudDataGuard",
+ "resource_type_i18n_display_name": "cloudDataGuard",
+ "regions": [
+ "eu-de"
+ ]
+ },
+ {
+ "global": false,
+ "resource_type": "subscription",
+ "resource_type_i18n_display_name": "subscription",
+ "regions": [
+ "eu-de"
+ ]
+ },
+ {
+ "global": false,
+ "resource_type": "backupMigration",
+ "resource_type_i18n_display_name": "backupMigration",
+ "regions": [
+ "eu-de"
+ ]
+ },
+ {
+ "global": false,
+ "resource_type": "migration",
+ "resource_type_i18n_display_name": "migration",
+ "regions": [
+ "eu-de"
+ ]
+ }
+ ]
+ },
+ {
+ "provider": "dli",
+ "provider_i18n_display_name": "dli",
+ "resource_types": [
+ {
+ "global": false,
+ "resource_type": "dli_basic_datasource",
+ "resource_type_i18n_display_name": "dli_basic_datasource",
+ "regions": [
+ "eu-de"
+ ]
+ },
+ {
+ "global": false,
+ "resource_type": "dli_queue",
+ "resource_type_i18n_display_name": "dli_queue",
+ "regions": [
+ "eu-de"
+ ]
+ }
+ ]
+ },
+ {
+ "provider": "gaussdb",
+ "provider_i18n_display_name": "gaussdb",
+ "resource_types": [
+ {
+ "global": false,
+ "resource_type": "gaussdb",
+ "resource_type_i18n_display_name": "gaussdb",
+ "regions": [
+ "eu-de"
+ ]
+ }
+ ]
+ },
+ {
+ "provider": "er",
+ "provider_i18n_display_name": "er",
+ "resource_types": [
+ {
+ "global": false,
+ "resource_type": "instance",
+ "resource_type_i18n_display_name": "instance",
+ "regions": [
+ "eu-de"
+ ]
+ }
+ ]
+ },
+ {
+ "provider": "nosql",
+ "provider_i18n_display_name": "GaussDBNoSQL",
+ "resource_types": [
+ {
+ "global": false,
+ "resource_type": "nosql",
+ "resource_type_i18n_display_name": "nosql",
+ "regions": [
+ "cn-north-7",
+ "eu-de"
+ ]
+ }
+ ]
+ },
+ {
+ "provider": "as",
+ "provider_i18n_display_name": "AS",
+ "resource_types": [
+ {
+ "global": false,
+ "resource_type": "scaling_group",
+ "resource_type_i18n_display_name": "AS",
+ "regions": [
+ "ru-northwest-2"
+ ]
+ }
+ ]
+ },
+ {
+ "provider": "ecs",
+ "provider_i18n_display_name": "ecs",
+ "resource_types": [
+ {
+ "global": false,
+ "resource_type": "ecs",
+ "resource_type_i18n_display_name": "ECS",
+ "regions": [
+ "ru-northwest-2",
+ "eu-de",
+ "eu-nl"
+ ]
+ }
+ ]
+ },
+ {
+ "provider": "vpc",
+ "provider_i18n_display_name": "vpc",
+ "resource_types": [
+ {
+ "global": false,
+ "resource_type": "subnet",
+ "resource_type_i18n_display_name": "subnet",
+ "regions": [
+ "eu-de",
+ "eu-nl"
+ ]
+ },
+ {
+ "global": false,
+ "resource_type": "eip",
+ "resource_type_i18n_display_name": "eip",
+ "regions": [
+ "eu-de"
+ ]
+ },
+ {
+ "global": false,
+ "resource_type": "vpc",
+ "resource_type_i18n_display_name": "vpc",
+ "regions": [
+ "eu-de",
+ "eu-nl"
+ ]
+ },
+ {
+ "global": false,
+ "resource_type": "nat_gateways",
+ "resource_type_i18n_display_name": "nat_gateways",
+ "regions": [
+ "eu-de"
+ ]
+ },
+ {
+ "global": false,
+ "resource_type": "nat_gateways",
+ "resource_type_i18n_display_name": "nat_gateways",
+ "regions": [
+ "eu-de"
+ ]
+ },
+ {
+ "global": false,
+ "resource_type": "loadbalancers",
+ "resource_type_i18n_display_name": "loadbalancers",
+ "regions": [
+ "eu-de",
+ "eu-nl"
+ ]
+ },
+ {
+ "global": false,
+ "resource_type": "listeners",
+ "resource_type_i18n_display_name": "listeners",
+ "regions": [
+ "eu-de",
+ "eu-nl"
+ ]
+ },
+ {
+ "global": false,
+ "resource_type": "ipsec-site-connections",
+ "resource_type_i18n_display_name": "ipsec-site-connections",
+ "regions": [
+ "eu-de",
+ "eu-nl"
+ ]
+ },
+ {
+ "global": false,
+ "resource_type": "nat_gateways",
+ "resource_type_i18n_display_name": "nat_gateways",
+ "regions": [
+ "eu-de"
+ ]
+ },
+ {
+ "global": false,
+ "resource_type": "nat_gateways",
+ "resource_type_i18n_display_name": "nat_gateways",
+ "regions": [
+ "eu-de",
+ "eu-nl"
+ ]
+ },
+ {
+ "global": false,
+ "resource_type": "nat_gateways",
+ "resource_type_i18n_display_name": "nat_gateways",
+ "regions": [
+ "eu-de",
+ "eu-nl"
+ ]
+ },
+ {
+ "global": false,
+ "resource_type": "nat_gateways",
+ "resource_type_i18n_display_name": "nat_gateways",
+ "regions": [
+ "eu-de",
+ "eu-nl"
+ ]
+ },
+ {
+ "global": false,
+ "resource_type": "nat_gateways",
+ "resource_type_i18n_display_name": "nat_gateways",
+ "regions": [
+ "eu-de",
+ "eu-nl"
+ ]
+ },
+ {
+ "global": false,
+ "resource_type": "nat_gateways",
+ "resource_type_i18n_display_name": "nat_gateways",
+ "regions": [
+ "eu-de"
+ ]
+ },
+ {
+ "global": false,
+ "resource_type": "nat_gateways",
+ "resource_type_i18n_display_name": "nat_gateways",
+ "regions": [
+ "eu-de"
+ ]
+ },
+ {
+ "global": false,
+ "resource_type": "nat_gateways",
+ "resource_type_i18n_display_name": "nat_gateways",
+ "regions": [
+ "eu-de"
+ ]
+ },
+ {
+ "global": false,
+ "resource_type": "nat_gateways",
+ "resource_type_i18n_display_name": "nat_gateways",
+ "regions": [
+ "eu-de",
+ "eu-nl"
+ ]
+ },
+ {
+ "global": false,
+ "resource_type": "nat_gateways",
+ "resource_type_i18n_display_name": "nat_gateways",
+ "regions": [
+ "eu-de",
+ "eu-nl"
+ ]
+ },
+ {
+ "global": false,
+ "resource_type": "nat_gateways",
+ "resource_type_i18n_display_name": "nat_gateways",
+ "regions": [
+ "eu-de",
+ "eu-nl"
+ ]
+ },
+ {
+ "global": false,
+ "resource_type": "nat_gateways",
+ "resource_type_i18n_display_name": "nat_gateways",
+ "regions": [
+ "eu-de",
+ "eu-nl"
+ ]
+ },
+ {
+ "global": false,
+ "resource_type": "nat_gateways",
+ "resource_type_i18n_display_name": "nat_gateways",
+ "regions": [
+ "eu-de"
+ ]
+ },
+ {
+ "global": false,
+ "resource_type": "nat_gateways",
+ "resource_type_i18n_display_name": "nat_gateways",
+ "regions": [
+ "eu-de"
+ ]
+ }
+ ]
+ },
+ {
+ "provider": "DBSS",
+ "provider_i18n_display_name": "Database Security Service",
+ "resource_types": [
+ {
+ "global": false,
+ "resource_type": "auditInstance",
+ "resource_type_i18n_display_name": "Database Security Service",
+ "regions": [
+ "eu-de"
+ ]
+ }
+ ]
+ },
+ {
+ "provider": "FunctionGraph",
+ "provider_i18n_display_name": "FunctionGraph",
+ "resource_types": [
+ {
+ "global": false,
+ "resource_type": "functions",
+ "resource_type_i18n_display_name": "functions",
+ "regions": [
+ "eu-de"
+ ]
+ }
+ ]
+ },
+ {
+ "provider": "dms",
+ "provider_i18n_display_name": "dms",
+ "resource_types": [
+ {
+ "global": false,
+ "resource_type": "kafka",
+ "resource_type_i18n_display_name": "kafka",
+ "regions": [
+ "eu-de"
+ ]
+ }
+ ]
+ },
+ {
+ "provider": "dcs",
+ "provider_i18n_display_name": "dcs",
+ "resource_types": [
+ {
+ "global": false,
+ "resource_type": "dcs",
+ "resource_type_i18n_display_name": "dcs",
+ "regions": [
+ "eu-de"
+ ]
+ }
+ ]
+ },
+ {
+ "provider": "css",
+ "provider_i18n_display_name": "css",
+ "resource_types": [
+ {
+ "global": false,
+ "resource_type": "css-cluster",
+ "resource_type_i18n_display_name": "css-cluster",
+ "regions": [
+ "eu-de"
+ ]
+ }
+ ]
+ },
+ {
+ "provider": "cce",
+ "provider_i18n_display_name": "cce",
+ "resource_types": [
+ {
+ "global": false,
+ "resource_type": "cce-cluster",
+ "resource_type_i18n_display_name": "cce-cluster",
+ "regions": [
+ "eu-de"
+ ]
+ }
+ ]
+ },
+ {
+ "provider": "ims",
+ "provider_i18n_display_name": "ims",
+ "resource_types": [
+ {
+ "global": false,
+ "resource_type": "private_image",
+ "resource_type_i18n_display_name": "private_image",
+ "regions": [
+ "eu-de"
+ ]
+ }
+ ]
+ },
+ {
+ "provider": "vbs",
+ "provider_i18n_display_name": "vbs",
+ "resource_types": [
+ {
+ "global": false,
+ "resource_type": "backup",
+ "resource_type_i18n_display_name": "backup",
+ "regions": [
+ "eu-de"
+ ]
+ }
+ ]
+ },
+ {
+ "provider": "autoback",
+ "provider_i18n_display_name": "autoback",
+ "resource_types": [
+ {
+ "global": false,
+ "resource_type": "backup_policy",
+ "resource_type_i18n_display_name": "backup_policy",
+ "regions": [
+ "eu-de"
+ ]
+ }
+ ]
+ },
+ {
+ "provider": "rds",
+ "provider_i18n_display_name": "rds",
+ "resource_types": [
+ {
+ "global": false,
+ "resource_type": "rds",
+ "resource_type_i18n_display_name": "rds",
+ "regions": [
+ "eu-de"
+ ]
+ }
+ ]
+ },
+ {
+ "provider": "csbs",
+ "provider_i18n_display_name": "csbs",
+ "resource_types": [
+ {
+ "global": false,
+ "resource_type": "vault",
+ "resource_type_i18n_display_name": "vault",
+ "regions": [
+ "eu-de"
+ ]
+ },
+ {
+ "global": false,
+ "resource_type": "csbs_backup",
+ "resource_type_i18n_display_name": "csbs_backup",
+ "regions": [
+ "eu-de"
+ ]
+ },
+ {
+ "global": false,
+ "resource_type": "csbs_backup_policy",
+ "resource_type_i18n_display_name": "csbs_backup_policy",
+ "regions": [
+ "eu-de"
+ ]
+ }
+ ]
+ },
+ {
+ "provider": "dns",
+ "provider_i18n_display_name": "dns",
+ "resource_types": [
+ {
+ "global": false,
+ "resource_type": "DNS_ptr_record",
+ "resource_type_i18n_display_name": "DNS_ptr_record",
+ "regions": [
+ "eu-de"
+ ]
+ },
+ {
+ "global": true,
+ "resource_type": "DNS_private_zone",
+ "resource_type_i18n_display_name": "DNS_private_zone",
+ "regions": [
+ "eu-de",
+ "eu-nl"
+ ]
+ },
+ {
+ "global": true,
+ "resource_type": "DNS_private_recordset",
+ "resource_type_i18n_display_name": "DNS_private_recordset",
+ "regions": [
+ "eu-de"
+ ]
+ }
+ ]
+ },
+ {
+ "provider": "evs",
+ "provider_i18n_display_name": "evs",
+ "resource_types": [
+ {
+ "global": false,
+ "resource_type": "disk",
+ "resource_type_i18n_display_name": "disk",
+ "regions": [
+ "",
+ "eu-de"
+ ]
+ }
+ ]
+ },
+ {
+ "provider": "kms",
+ "provider_i18n_display_name": "kms",
+ "resource_types": [
+ {
+ "global": false,
+ "resource_type": "kms",
+ "resource_type_i18n_display_name": "kms",
+ "regions": [
+ "eu-de"
+ ]
+ }
+ ]
+ },
+ {
+ "provider": "smn",
+ "provider_i18n_display_name": "smn",
+ "resource_types": [
+ {
+ "global": false,
+ "resource_type": "smn_topic",
+ "resource_type_i18n_display_name": "smn_topic",
+ "regions": [
+ "eu-de"
+ ]
+ }
+ ]
+ },
+ {
+ "provider": "dws",
+ "provider_i18n_display_name": "dws",
+ "resource_types": [
+ {
+ "global": false,
+ "resource_type": "dws_clusters",
+ "resource_type_i18n_display_name": "dws_clusters",
+ "regions": [
+ "eu-de"
+ ]
+ }
+ ]
+ },
+ {
+ "provider": "bms",
+ "provider_i18n_display_name": "bms",
+ "resource_types": [
+ {
+ "global": false,
+ "resource_type": "bms_server",
+ "resource_type_i18n_display_name": "bms_server",
+ "regions": [
+ "eu-de"
+ ]
+ }
+ ]
+ },
+ {
+ "provider": "deh",
+ "provider_i18n_display_name": "deh",
+ "resource_types": [
+ {
+ "global": false,
+ "resource_type": "dedicated-host-tags",
+ "resource_type_i18n_display_name": "dedicated-host-tags",
+ "regions": [
+ "eu-de"
+ ]
+ }
+ ]
+ },
+ {
+ "provider": "waf",
+ "provider_i18n_display_name": "waf",
+ "resource_types": [
+ {
+ "global": false,
+ "resource_type": "waf",
+ "resource_type_i18n_display_name": "waf",
+ "regions": [
+ "eu-de"
+ ]
+ }
+ ]
+ },
+ {
+ "provider": "sfs",
+ "provider_i18n_display_name": "sfs",
+ "resource_types": [
+ {
+ "global": false,
+ "resource_type": "sfs",
+ "resource_type_i18n_display_name": "sfs",
+ "regions": [
+ "eu-de"
+ ]
+ }
+ ]
+ },
+ {
+ "provider": "obs",
+ "provider_i18n_display_name": "obs",
+ "resource_types": [
+ {
+ "global": false,
+ "resource_type": "bucket",
+ "resource_type_i18n_display_name": "bucket",
+ "regions": [
+ "eu-de"
+ ]
+ }
+ ]
+ },
+ {
+ "provider": "sdrs",
+ "provider_i18n_display_name": "sdrs",
+ "resource_types": [
+ {
+ "global": false,
+ "resource_type": "sdrs",
+ "resource_type_i18n_display_name": "sdrs",
+ "regions": [
+ "eu-de"
+ ]
+ }
+ ]
+ },
+ {
+ "provider": "dds",
+ "provider_i18n_display_name": "dds",
+ "resource_types": [
+ {
+ "global": false,
+ "resource_type": "dds",
+ "resource_type_i18n_display_name": "dds",
+ "regions": [
+ "eu-de"
+ ]
+ }
+ ]
+ },
+ {
+ "provider": "mrs",
+ "provider_i18n_display_name": "mrs",
+ "resource_types": [
+ {
+ "global": false,
+ "resource_type": "clusters",
+ "resource_type_i18n_display_name": "clusters",
+ "regions": [
+ "eu-de"
+ ]
+ }
+ ]
+ }
+ ],
+ "total_count": 32
+}
+See Status Codes.
+See Error Codes.
+You can use this API to filter resources by tag.
+POST /v1.0/resource-instances/filter
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+Specifies the user token. TMS is a global service. So you need to set scope to domain when calling an IAM API to obtain a user token. The value of X-Subject-Token in the response header is the user token. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+No + |
+String + |
+Project ID. This parameter is mandatory when resource_type is a region-specific service. + |
+
resource_types + |
+Yes + |
+Array of strings + |
+Resource type. This parameter is case-sensitive. Supported resource types can be provided as ecs,scaling_group, images, disk,vpcs,security-groups, shared_bandwidth,eip, cdn. + |
+
tags + |
+Yes + |
+Array of Tag objects + |
+Tags + |
+
without_any_tag + |
+No + |
+Boolean + |
+Specifies whether to query only untagged resources. If this parameter is set to true, only untagged resources are queried. + |
+
offset + |
+No + |
+Integer + |
+Index position. The query starts from the next data specified by offset. The value must be a number and cannot be negative. The default value is 0. + |
+
limit + |
+No + |
+Integer + |
+The maximum queries supported. The value 200 is used by default if this parameter is not set. The value range is 1 to 200. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
key + |
+Yes + |
+String + |
+Key. +It cannot be left blank and can contain a maximum of 36 Unicode characters. Only digits, letters, hyphens (-), at signs (@), and underscores (_) are allowed. + |
+
values + |
+Yes + |
+Array of strings + |
+Specifies tag values. +Each value contains a maximum of 43 Unicode characters and can be an empty string. Only digits, letters, hyphens (-), at signs (@), and underscores (_) are allowed. + |
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
resources + |
+Array of Resources objects + |
+Specifies resources. + |
+
errors + |
+Array of Errors objects + |
+Specifies resources of the tag. + |
+
total_count + |
+Integer + |
+Specifies the total number of resources of the tag. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
project_id + |
+String + |
+ProjectID + |
+
project_name + |
+String + |
+Specifies the project name. + |
+
resource_id + |
+String + |
+Specifies the resource ID. + |
+
resource_name + |
+String + |
+Specifies the resource name. + |
+
resource_type + |
+String + |
+Specifies the resource type. + |
+
tags + |
+Array of FilterTagResponse objects + |
+Specifies the resource tag. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
key + |
+String + |
+Specifies the key. +It cannot be left blank and can contain a maximum of 36 Unicode characters. Only digits, letters, hyphens (-), at signs (@), and underscores (_) are allowed. + |
+
value + |
+String + |
+Specifies the value. +Each value contains a maximum of 43 Unicode characters and can be an empty string. Only digits, letters, hyphens (-), at signs (@), and underscores (_) are allowed. + |
+
Filtering resources by tag
+POST https://v1.0/resource-instances/filter
+
+{
+ "project_id" : "e1eb7c40cbeaxxxxxxcde527594a306d",
+ "resource_types" : [ "disk", "ecs" ],
+ "tags" : [ {
+ "key" : "env",
+ "values" : [ "dev", "prod" ]
+ }, {
+ "key" : "test",
+ "values" : [ "test" ]
+ } ],
+
+ "without_any_tag" : true,
+ "offset" : 0,
+ "limit" : 10
+}
+Status code: 200
+Successful operation
+{
+ "resources" : [ {
+ "project_id" : "e1eb7c40cbeaxxxxxxde527594a306d",
+ "project_name" : "XXXX",
+ "resource_type" : "disk",
+ "resource_id" : "b621f5ae-xxxx-xxxx-xxxx-752c445434b4",
+ "resource_name" : "xxx1-volume-0001",
+ "tags" : [ {
+ "key" : "ENV",
+ "value" : "dev"
+ } ]
+ }, {
+ "project_id" : "e1eb7c40cbxxxxxx89cde527594a306d",
+ "project_name" : "XXXX",
+ "resource_type" : "disk",
+ "resource_id" : "87c9edc9-xxxx-xxxx-xxxx-372b2e22d579",
+ "resource_name" : "xxx2-volume-0002",
+ "tags" : [ {
+ "key" : "test",
+ "value" : "test"
+ } ]
+ } ],
+ "errors" : [],
+ "total_count" : 2
+}
+See Status Codes.
+See Error Codes.
+You can use this API to query any tag key in a specified region.
+GET /v1.0/tag-keys
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
region_id + |
+No + |
+String + |
+Region ID + |
+
limit + |
+No + |
+Integer + |
+The maximum queries supported. The value range is 1 to 200. If this parameter is not specified, the default value 200 is used by default. +Minimum value: 1 +Maximum value: 200 +Default value: 200 + |
+
marker + |
+No + |
+String + |
+Paging location identifier (index). The query starts from the next piece of data indexed by this parameter. When querying the data on the first page, you do not need to specify this parameter. When querying the data on subsequent pages, set this parameter to the value in the response body returned by querying data of the previous page. When the returned next_marker is empty, the last page has been queried. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+User token. TMS is a global service. So you need to set scope to domain when calling an IAM API to obtain a user token. The value of X-Subject-Token in the response header is the user token. + |
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
keys + |
+Array of strings + |
+Tag keys. + |
+
page_info + |
+PageInfoTagKeys object + |
+Pagination information + |
+
Query tag keys
+GET https://{Endpoint}/v1.0/tag-keys?limit=10&marker=9
+Status code: 200
+Successful operation
+{
+ "keys" : [ "ENV1", "ENV2" ],
+ "page_info" : [ {
+ "next_marker" : "9",
+ "current_count" : 10
+ } ]
+}
+See Status Codes.
+See Error Codes.
+You can use this API to query any tag value in a specified region.
+GET /v1.0/tag-values
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
region_id + |
+No + |
+String + |
+Region ID + |
+
limit + |
+No + |
+Integer + |
+The maximum queries supported. The value range is 1 to 200. If this parameter is not specified, the default value 200 is used by default. +Minimum value: 1 +Maximum value: 200 +Default value: 10 + |
+
marker + |
+No + |
+String + |
+Paging location identifier (index). The query starts from the next piece of data indexed by this parameter. When querying the data on the first page, you do not need to specify this parameter. When querying the data on subsequent pages, set this parameter to the value in the response body returned by querying data of the previous page. When the returned next_marker is empty, the last page has been queried. + |
+
key + |
+Yes + |
+String + |
+Tag key. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+User token. TMS is a global service. So you need to set scope to domain when calling an IAM API to obtain a user token. The value of X-Subject-Token in the response header is the user token. + |
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
values + |
+Array of strings + |
+Tag values queried. + |
+
page_info + |
+PageInfoTagValues object + |
+Pagination information + |
+
Querying tag values
+GET https://{Endpoint}/v1.0/tag-values?limit=10&marker=9&key=dev
+Status code: 200
+Successful operation
+{
+ "values" : [ "ENV1", "ENV2" ],
+ "page_info" : [ {
+ "next_marker" : "9",
+ "current_count" : 10
+ } ]
+}
+See Status Codes.
+See Error Codes.
+This API is used to query tag quotas.
+GET /v1.0/tms/quotas
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+Specifies the user token. TMS is a global service. So you need to set scope to domain when calling an IAM API to obtain a user token. The value of X-Subject-Token in the response header is the user token. + |
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
quotas + |
+Array of TagQuota objects + |
+Quota lists + |
+
Querying tag quotas
+GET https://{Endpoint}/v1.0/tms/quotas
+Status code: 200
+Successful operation
+{
+ "quotas" : [ {
+ "used" : 4,
+ "unit" : "count",
+ "quota_key" : "predefine_tag",
+ "quota_limit" : 500
+ } ]
+}
+See Status Codes.
+See Error Codes.
+POST /v1.0/predefine_tags/action
Name +
|
|---|