Querying an API Version

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

View PDF

Function

This API is used to query a specified API version of SMS.

Calling Method

For details, see Calling APIs.

URI

GET /{version}

**Table 1** Path parameter
Parameter	Mandatory	Type	Description
version	Yes	String	The version information. Minimum length: 1 character Maximum length: 10 characters

Request

None

Response

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
id	String	The API version. Minimum length: 0 characters Maximum length: 255 characters
links	Array of Link objects	The API link address. Array length: 0 to 1,024 characters
status	String	The version status. SUPPORTED indicates the version is supported. Minimum length: 0 characters Maximum length: 255 characters
updated	String	The time when the version is updated. The format is yyyy-mm-ddThh:mm:ssZ. T is the separator between the calendar and the hourly notation of time. Z indicates the UTC. Example: 2018-09-30T00:00:00Z Minimum length: 0 characters Maximum length: 255 characters

**Table 3** **Link** field description
Parameter	Type	Description
href	String	The URL of the API version. Minimum length: 0 characters Maximum length: 1,024 characters
rel	String	Its value is self, indicating that href is a local link. Minimum length: 0 characters Maximum length: 1,024 characters

Example Request

This example queries a specified SMS API version.

GET https://{endpoint}/v3

{
  "links" : [ {
    "rel" : "self",
    "href" : "https://sms.ap-southeast-1.myhuaweicloud.com/v3"
  } ],
  "id" : "v3",
  "updated" : "2020-09-02T17:50:00Z",
  "status" : "SUPPORTED"
}

Example Response

Status code: 200

{
  "links" : [ {
    "rel" : "self",
    "href" : "https://sms.ap-southeast-1.myhuaweicloud.com/v3"
  } ],
  "id" : "v3",
  "updated" : "2020-09-02T17:50:00Z",
  "status" : "SUPPORTED"
}

Status Codes

Status Code	Description
200	Response returned.

Error Codes

For details, see Error Codes.

Parent topic: API Version Query

Previous topic: Listing API Versions

Next topic: Agent Running

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel