查询指定API版本信息ShowSpecifiedApiVersion
.jpg)
.jpg)
.jpg)
.jpg)
接口说明
查询 存储容灾 指定API版本信息。
约束说明
无
URL
GET https://sdrs.cn-north-4.myhuaweicloud.com/{api_version}
请求参数
| 名称 | 类型 | IN | 必选 | 描述 |
|---|---|---|---|---|
|
api_version
|
string | path | 是 |
API版本号。例如: v1。 |
返回参数
返回码: 200
OK
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
version
|
ShowApiVersionParams object | 是 |
API版本信息。 |
200 version
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
id
|
string | 是 |
版本ID(版本号),如v1。 |
|
links
|
Array of ShowApiVersionLinksParams objects | 是 |
版本号查询链接 |
|
version
|
string | 是 |
若该版本API支持微版本,则返回支持的最大微版本号,如果不支持微版本,则返回空。 |
|
status
|
string | 是 |
版本状态,为如下3种: CURRENT:表示该版本为主推版本 SUPPORTED:表示为老版本,但是现在还继续支持 DEPRECATED:表示为废弃版本,存在后续删除的可能 |
|
updated
|
string | 是 |
版本发布时间,采用UTC时间表示。如v1发布的时间2018-05-30T15:00:00Z。 |
|
min_version
|
string | 是 |
若该版本API 支持微版本,则返回支持的最小微版本号,如果不支持微版本,则返回空。 |
200 version.links
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
rel
|
string | 是 |
链接的描述 |
|
href
|
string | 是 |
版本号查询链接 |
返回码: 400
Bad Request
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
error
|
ErrorInfo object | 否 |
失败返回结构 |
400 error
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
message
|
string | 是 |
错误信息 |
|
code
|
string | 是 |
错误码 |
返回码: 401
Unauthorized
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
error
|
ErrorInfo object | 否 |
失败返回结构 |
401 error
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
message
|
string | 是 |
错误信息 |
|
code
|
string | 是 |
错误码 |
返回码: 403
Forbidden
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
error
|
ErrorInfo object | 否 |
失败返回结构 |
403 error
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
message
|
string | 是 |
错误信息 |
|
code
|
string | 是 |
错误码 |
返回码: 404
Not Found
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
error
|
ErrorInfo object | 否 |
失败返回结构 |
404 error
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
message
|
string | 是 |
错误信息 |
|
code
|
string | 是 |
错误码 |
返回码: 405
Method Not Allowed
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
error
|
ErrorInfo object | 否 |
失败返回结构 |
405 error
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
message
|
string | 是 |
错误信息 |
|
code
|
string | 是 |
错误码 |
返回码: 406
Not Acceptable
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
error
|
ErrorInfo object | 否 |
失败返回结构 |
406 error
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
message
|
string | 是 |
错误信息 |
|
code
|
string | 是 |
错误码 |
返回码: 407
Proxy Authentication Required
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
error
|
ErrorInfo object | 否 |
失败返回结构 |
407 error
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
message
|
string | 是 |
错误信息 |
|
code
|
string | 是 |
错误码 |
返回码: 408
Request Timeout
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
error
|
ErrorInfo object | 否 |
失败返回结构 |
408 error
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
message
|
string | 是 |
错误信息 |
|
code
|
string | 是 |
错误码 |
返回码: 409
Conflict
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
error
|
ErrorInfo object | 否 |
失败返回结构 |
409 error
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
message
|
string | 是 |
错误信息 |
|
code
|
string | 是 |
错误码 |
返回码: 500
Internal Server Error
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
error
|
ErrorInfo object | 否 |
失败返回结构 |
500 error
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
message
|
string | 是 |
错误信息 |
|
code
|
string | 是 |
错误码 |
返回码: 501
Not Implemented
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
error
|
ErrorInfo object | 否 |
失败返回结构 |
501 error
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
message
|
string | 是 |
错误信息 |
|
code
|
string | 是 |
错误码 |
返回码: 502
Bad Gateway
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
error
|
ErrorInfo object | 否 |
失败返回结构 |
502 error
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
message
|
string | 是 |
错误信息 |
|
code
|
string | 是 |
错误码 |
返回码: 503
Service Unavailable
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
error
|
ErrorInfo object | 否 |
失败返回结构 |
503 error
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
message
|
string | 是 |
错误信息 |
|
code
|
string | 是 |
错误码 |
返回码: 504
Gateway Timeout
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
error
|
ErrorInfo object | 否 |
失败返回结构 |
504 error
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
message
|
string | 是 |
错误信息 |
|
code
|
string | 是 |
错误码 |
请求示例
示例 1
"GET https://{endpoint}/v1"
返回示例
返回码：200
OK
示例 1
{
"version": {
"id": "v1",
"links": [
{
"href": "https://sdrs.localdomain.com/v1",
"rel": "self"
}
],
"status": "CURRENT",
"updated": "2018-05-30T00:00:00Z",
"version": "",
"min_version": ""
}
}
"version": {
"id": "v1",
"links": [
{
"href": "https://sdrs.localdomain.com/v1",
"rel": "self"
}
],
"status": "CURRENT",
"updated": "2018-05-30T00:00:00Z",
"version": "",
"min_version": ""
}
}
SDK
点击 存储容灾服务 (SDRS) SDK, 下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。
错误码
请参考 错误码说明。
