• Domain Name Service

dns
  1. Help Center
  2. Domain Name Service
  3. API Reference
  4. API Description
  5. Version Management
  6. Querying the DNS API Version

Querying the DNS API Version

Function

Query a specified DNS API version.

To be interconnected with a third-party system, the current DNS version supports 1024- and 2048-bit DH key exchange algorithms, and the 2048-bit algorithm is recommended.

URI

GET /{version}

For details, see Table 1.
Table 1 Parameter in the URI

Parameter

Mandatory

Type

Description

version

Yes

string

Version to be queried, which starts with v, for example, v2

Request

None

Response

  • Parameter description
    Table 2 Parameter in the response

    Parameter

    Type

    Description

    version

    object

    Version object

    Table 3 Description of the version field

    Parameter

    Type

    Description

    status

    string

    Version status, which can be the following:

    CURRENT: widely used version

    SUPPORT: earlier version which is still supported

    DEPRECATED: deprecated version which may be deleted later

    id

    string

    Version number, for example, v2

    updated

    string

    Version release time, which must be UTC time

    version

    string

    Maximum microversion number. If the APIs do not support microversions, the value is left blank.

    min_version

    string

    Minimum microversion number. If the APIs do not support microversions, the value is left blank.

    links

    object

    URL of the current version

  • Example response
    {
            "version": 
                {
                    "status": "CURRENT",
                    "id": "v2",
                    "links": [
                        {
                            "href": "https://127.0.0.1/v2/",
                            "rel": "self"
                        }
                    ],
                "min_version": "",
                "updated": "2018-09-18T00:00:00Z",
                "version": ""
                }
    }

Returned Value

See General Request Return Code.