1
0
forked from docs/doc-exports
doc-exports/docs/dc/api-ref/en-dc_topic_0055025312.html
Qin Ying, Fan 4a7d4f4cd8 DC API 0930 version
Reviewed-by: Kucerak, Kristian <kristian.kucerak@t-systems.com>
Co-authored-by: Qin Ying, Fan <fanqinying@huawei.com>
Co-committed-by: Qin Ying, Fan <fanqinying@huawei.com>
2022-10-06 09:33:01 +00:00

8.2 KiB

Querying a Specified API Version

Function

This API is used to query a specified API version supported by Direct Connect.

URI

GET /{api_version}

Request

None

Response

Table 1 lists the response parameters.

Table 1 Response parameters

Parameter

Type

Description

id

String

Specifies the version number, for example, v2.0.

links

Array

Specifies the API URL.

href

String

Specifies the reference address of the current API version.

rel

String

Specifies the relationship between the current API version and the referenced address.

version

String

Specifies the version. If APIs of this version support minor versions, set this parameter to the supported maximum minor version. If minor versions are not supported, leave this parameter blank.

status

String

Specifies the version status. Value options are as follows:

  • CURRENT: indicates a primary version.
  • SUPPORTED: indicates an old version that is still supported.
  • DEPRECATED: indicates a deprecated version that may be deleted later.

updated

String

Specifies the version release time in UTC. Specifies the time when v1 APIs are released, for example, 2014-06-28T12:20:21Z.

min_version

String

Specifies the version. If APIs of this version supports minor versions, set this parameter to the supported minimum minor version. If minor versions are not supported, leave this parameter blank.

Examples

  • Example request
    GET /v2.0
  • Example response
    {
      "version": {
        "id": "v2.0",
        "links": [
          {
            "href": "https://dcaas.***region.myhwclouds.com/v2.0",
            "rel": "self"
          }
        ],
        "updated": "2017-11-30T00:00:00Z",
        "status": "CURRENT",
        "version": "",
        "min_version": ""
      }
    }