接口介绍
文件系统续订
接口约束
只支持onDemand为false的资源进行续订
URI
POST /v4/sfs/renew
路径参数
无
Query 参数
无
请求参数
请求头 header 参数
无
请求体 body 参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
resourceID | 是 | String | 文件系统资源 ID | 参考请求示例 |
regionID | 是 | String | 资源池ID | 参考请求示例 |
cycleType | 是 | String | 包周期类型,year/month | 参考请求示例 |
cycleCount | 是 | Integer | 包周期数。周期最大长度不能超过 3 年 | 参考请求示例 |
clientToken | 否 | String | 客户端存根,用于保证订单幂等性。要求单个云平台账户内唯一 | 参考请求示例 |
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
statusCode | 是 | Integer | 返回状态码(800为成功,900为订单处理中/失败) | 800 |
message | 否 | String | 失败时的错误描述,一般为英文描述 | 参考结果码 |
description | 否 | String | 失败时的错误描述,一般为中文描述 | 参考结果码 |
returnObj | 是 | Object | returnObj | 参考响应示例 |
errorCode | 否 | String | 业务细分码,为 product.module.code 三段式码 | 参考结果码 |
表returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
masterOrderID | 是 | String | 订单 ID。调用方在拿到 masterOrderID 之后,在若干错误 情况下,可以使用 masterOrderID 进一步确认订单状态及 资源状态 |
参考响应示例 |
masterOrderNO | 否 | String | 订单号 | 参考响应示例 |
regionID | 是 | String | 资源池 ID | 参考响应示例 |
请求示例
请求头
无
请求体 body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"resourceID": "e7b8ffa5a37d44d1b1eec51f125f8fc9",
"cycleType": "month",
"cycleCount": 10,
"clientToken": "yc-11111"
}
响应示例
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"masterOrderID": "bcc0f0c242fc11edb4710242ac110003",
"masterOrderNO": null
}
状态码
状态码 | 说明 |
---|---|
200 | 表示请求成功 |
错误码
请参考错误码说明