Querying a Specified API Version
Function
This API is used to query a specific DNS API version.
Calling Method
For details, see Calling APIs.
URI
GET /{version}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
version |
Yes |
String |
Definition Version to be queried Constraints N/A Range v2 Default Value N/A |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
version |
VersionItem object |
Definition Version to be queried Range v2 |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Definition Version Range v2 |
status |
String |
Definition Version status Range
|
links |
Array of LinksItem objects |
Definition API URL. Range N/A |
updated |
String |
Definition Version release time Range N/A |
version |
String |
Definition Maximum micro-version number Range If the APIs do not support micro-versions, you need to leave the parameter blank. |
min_version |
String |
Definition Minimum micro-version number Range If the APIs do not support micro-versions, you need to leave the parameter blank. |
Parameter |
Type |
Description |
---|---|---|
href |
String |
Definition Shortcut link Range N/A |
rel |
String |
Definition Shortcut link marker name Range N/A |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
code |
String |
Definition Error code Range N/A |
message |
String |
Definition Error description Range N/A |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
code |
String |
Definition Error code Range N/A |
message |
String |
Definition Error description Range N/A |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
code |
String |
Definition Error code Range N/A |
message |
String |
Definition Error description Range N/A |
Example Requests
Querying a specific DNS API version.
GET https://{endpoint}/v2
Example Responses
Status code: 200
Querying a specified API version
{ "version" : { "status" : "CURRENT", "id" : "v2", "links" : [ { "href" : "https://Endpoint/v2/", "rel" : "self" } ], "min_version" : "", "updated" : "2018-09-18T00:00:00Z", "version" : "" } }
Status Codes
Status Code |
Description |
---|---|
200 |
Querying a specified API version |
400 |
Error response |
404 |
Error response |
500 |
Error response |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.