On this page

Function
Calling Method
URI
Request Parameters
Response Parameters
Example Requests
Example Responses
Status Codes
Error Codes

Show all

Help Center/ Tag Management Service/ API Reference/ API Description/ Services Supported by Tag Management Service/ Querying Services Supported by TMS

Querying Services Supported by TMS

Updated on 2024-01-09 GMT+08:00

View PDF

Function

This API is used to query services supported by TMS.

Calling Method

For details, see Calling APIs.

URI

GET /v1.0/tms/providers

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
locale	No	String	Specifies the display language. Default: zh-cn
limit	No	Integer	Specifies the number of records to be queried, which is 10 by default. The maximum value is 200 and the minimum value is 1.
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 a negative number. The default value is 0.
provider	No	String	Specifies the cloud service name.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies the user token. TMS is a global service. When calling the Identity and Access Management (IAM) API to obtain a user token, set the scope field to domain. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
providers	Array of ProviderResponseBody objects	Specifies cloud services.
total_count	Integer	Specifies the total number of cloud services supported by TMS.

**Table 4** ProviderResponseBody
Parameter	Type	Description
provider	String	Specifies the cloud service name.
provider_i18n_display_name	String	Specifies the display name of the resource. You can configure the language by setting the locale parameter.
resource_types	Array of ResourceTypeBody objects	Specifies the resource type list.

**Table 5** ResourceTypeBody
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 configure the language by setting the locale parameter.
regions	Array of strings	Specifies supported regions.
global	Boolean	Specifies whether the resource is a global resource.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Response error information.

**Table 7** RespErrorMessage
Parameter	Type	Description
error_code	String	Request error code.
error_msg	String	Error message

Status code: 401

**Table 8** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Response error information.

**Table 9** RespErrorMessage
Parameter	Type	Description
error_code	String	Request error code.
error_msg	String	Error message

Status code: 402

**Table 10** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Response error information.

**Table 11** RespErrorMessage
Parameter	Type	Description
error_code	String	Request error code.
error_msg	String	Error message

Status code: 403

**Table 12** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Response error information.

**Table 13** RespErrorMessage
Parameter	Type	Description
error_code	String	Request error code.
error_msg	String	Error message

Status code: 404

**Table 14** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Response error information.

**Table 15** RespErrorMessage
Parameter	Type	Description
error_code	String	Request error code.
error_msg	String	Error message

Status code: 405

**Table 16** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Response error information.

**Table 17** RespErrorMessage
Parameter	Type	Description
error_code	String	Request error code.
error_msg	String	Error message

Status code: 406

**Table 18** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Response error information.

**Table 19** RespErrorMessage
Parameter	Type	Description
error_code	String	Request error code.
error_msg	String	Error message

Status code: 407

**Table 20** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Response error information.

**Table 21** RespErrorMessage
Parameter	Type	Description
error_code	String	Request error code.
error_msg	String	Error message

Status code: 408

**Table 22** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Response error information.

**Table 23** RespErrorMessage
Parameter	Type	Description
error_code	String	Request error code.
error_msg	String	Error message

Status code: 409

**Table 24** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Response error information.

**Table 25** RespErrorMessage
Parameter	Type	Description
error_code	String	Request error code.
error_msg	String	Error message

Status code: 500

**Table 26** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Response error information.

**Table 27** RespErrorMessage
Parameter	Type	Description
error_code	String	Request error code.
error_msg	String	Error message

Status code: 501

**Table 28** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Response error information.

**Table 29** RespErrorMessage
Parameter	Type	Description
error_code	String	Request error code.
error_msg	String	Error message

Status code: 502

**Table 30** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Response error information.

**Table 31** RespErrorMessage
Parameter	Type	Description
error_code	String	Request error code.
error_msg	String	Error message

Status code: 503

**Table 32** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Response error information.

**Table 33** RespErrorMessage
Parameter	Type	Description
error_code	String	Request error code.
error_msg	String	Error message

Status code: 504

**Table 34** Response body parameters
Parameter	Type	Description
error	RespErrorMessage object	Response error information.

**Table 35** RespErrorMessage
Parameter	Type	Description
error_code	String	Request error code.
error_msg	String	Error message

Example Requests

None

Example Responses

Status code: 200

{
  "providers" : [ {
    "provider" : "evs",
    "provider_i18n_display_name" : "Elastic Volume Service",
    "resource_types" : {
      "resource_type_i18n_display_name" : "EVS-Disk",
      "global" : false,
      "resource_type" : "disk",
      "regions" : [ "regionId1" ]
    }
  } ],
  "total_count" : 1
}

Status Codes

Status Code	Description
200	OK
400	Bad Request
401	Unauthorized
402	Payment Required
403	Forbidden
404	Not Found
405	Method Not Allowed
406	Not Acceptable
407	Proxy Authentication Required
408	Request Timeout
409	Conflict
500	Internal Server Error
501	Not Implemented
502	Bad Gateway
503	Service Unavailable
504	Gateway Timeout