链接复制成功!
修改文件系统计费模式由按需转为包周期 - ChangeShareChargeMode
功能介绍
修改文件系统计费模式由按需转为包周期。当前只在部分区域支持。具体的区域列表请参见API概览的接口说明。
接口约束
该接口仅适用于以下类型:
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
POST /v2/{project_id}/sfs-turbo/shares/{share_id}/change-charge-mode
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,用于标识资源所属的IAM项目空间,实现项目级资源隔离与权限管控。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| share_id | 是 | String | 参数解释: 文件系统ID,用于唯一标识SFS Turbo文件系统实例。 获取方法请参见查询文件系统列表接口。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,用于鉴权认证。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| Content-Type | 是 | String | 参数解释: 请求消息体MIME类型,用于标识请求正文的数据格式。 约束限制: 不涉及。 取值范围: application/json 默认取值: application/json |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| bss_param | 是 | BssInfo object | 参数解释: 按需转包周期的计费参数,包含周期类型、周期数、自动续费和自动扣款等配置。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| is_auto_renew | 否 | Long | 参数解释: 是否自动续费。 约束限制: 包周期计费场景下该参数生效。 取值范围: 默认取值: 0 |
| period_num | 是 | Long | 参数解释: 包周期订购的周期数。 约束限制: 包周期计费场景下该参数为必选。 取值范围: 默认取值: 不涉及。 |
| period_type | 是 | Long | 参数解释: 包周期的类型。 约束限制: 包周期计费场景下该参数为必选。 取值范围: 默认取值: 不涉及。 |
| is_auto_pay | 否 | Long | 参数解释: 是否生成订单后自动扣款。 约束限制: 包周期计费场景下该参数生效。 取值范围: 默认取值: 0 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| X-request-id | String | 参数解释: 请求ID,用于唯一标识和追踪本次请求。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| order_ids | Array of strings | 参数解释: 按需转包周期生成的订单ID列表。 取值范围: 不涉及。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| X-request-id | String | 参数解释: 请求ID,用于唯一标识和追踪本次请求。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| errCode | String | 参数解释: 错误码,用于标识请求失败的原因。详细错误码请参见错误码。 取值范围: 不涉及。 |
| errMsg | String | 参数解释: 错误描述,用于描述请求失败的具体原因,便于排查问题。请参见错误码。 取值范围: 不涉及。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| X-request-id | String | 参数解释: 请求ID,用于唯一标识和追踪本次请求。 取值范围: 不涉及。 |
请求示例
{
"bss_param" : {
"is_auto_renew" : 0,
"period_num" : 11,
"period_type" : 2,
"is_auto_pay" : 0
}
} 响应示例
状态码:200
状态码:400
{
"errCode" : "SFS.TURBO.0001",
"errMsg" : "parameter error"
} 状态码:500
{
"errCode" : "SFS.TURBO.0005",
"errMsg" : "Internal server error"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 修改文件系统计费模式为包周期成功。 |
| 400 | 客户端错误 |
| 500 | 内部错误 |
错误码
请参见错误码。