接口功能介绍
此接口提供用户实现云主机卸载一个或多个文件系统的功能
准备工作:
构造请求:在调用前需要了解如何构造请求,详情查看构造请求
认证鉴权:openapi请求需要进行加密调用,详细查看认证鉴权
接口约束
1. 云主机必须处于运行状态
2. 云主机和文件系统应属于同一个VPC
3. 云主机仅支持部分镜像类型卸载,windows镜像:windows server 2012 数据中心版 R2 64位中文版(主镜像)、windows server 2012 标准版 R2 64位中文版、windows server 2016 数据中心版 64位中文版、windows server 2019 数据中心版 64位中文版。linux镜像:CentOS-7.8-x86_64、CentOS-7.9-x86_64(主镜像)、 CentOS-8.0-x86_64、 CentOS-8.1-x86_64、 CentOS-8.2-x86_64、Ubuntu-18.04-x86_64、Ubuntu-20.04-x86_64、Ctyunos-2.0.1_220311-x86_64
URI
POST /v4/ecs/sfs/detach
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以查看地域和可用区来了解资源池 获取: 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
instanceID | 是 | String | 云主机ID,您可以查看弹性云主机了解云主机的相关信息 获取: 查 查询云主机列表 创 创建一台按量付费或包年包月的云主机 创 批量创建按量付费或包年包月云主机 |
b67b7f1f-095b-1249-b379-8dd5cc542a05 | |
sysInfoList | 是 | Array of Objects | 所解绑的文件系统详细信息 | sysInfoList | |
forceDel | 否 | Boolean | 是否强制解绑 (true/false),默认非强制 | false |
表 sysInfoList
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
fileSysRoute | 是 | String | 文件系统地址(固定值,每一个文件都有相对应的文件系统地址) | 55.243.4.20:/mnt/sfs_cap/e3aacef1e0be40559b38a5c2158aa62e_mqfb3ej839cdz7ub | |
mountPoint | 是 | String | 挂载点 | /mnt/docs |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 | |
errorCode | String | 错误码,为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
error | String | 错误码,为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
message | String | 失败时的错误信息,一般为英文描述 | SUCCESS | |
description | String | 失败时的错误描述,一般为中文描述 | 成功 | |
returnObj | Object | 返回参数 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
jobID | String | 任务ID | a8e88ab8-888e-8888-8b88-c8f88a88e8bf |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
示例1:云主机卸载一个文件系统
{
"regionID":"7f8653e8657d11edbb550242ac110006",
"instanceID":"d1e21b53-54d3-4a8b-af2b-215f823ca7ce",
"forceDel":false,
"sysInfoList":[
{
"fileSysRoute":"55.243.4.20:/mnt/sfs_cap/e3aacef1e0be40559b38a5c2158aa62e_mqfb3ej839cdz7ub",
"mountPoint":"/mnt/docs"
}
]
}
示例2:云主机卸载多个文件系统
{
"regionID":"7f8653e8657d11edbb550242ac110006",
"instanceID":"d1e21b53-54d3-4a8b-af2b-215f823ca7ce",
"forceDel":true,
"sysInfoList":[
{
"fileSysRoute":"55.243.4.20:/mnt/sfs_perf/e3aacef1e0be40559b38a5c2158aa62e_1qscdpa8t17fuv6r",
"mountPoint":"/mnt/docs/test1020"
},
{
"fileSysRoute":"55.243.4.20:/mnt/sfs_cap/e3aacef1e0be40559b38a5c2158aa62e_mqfb3ej839cdz7ub",
"mountPoint":"/mnt/docs/test1012"
},
{
"fileSysRoute":"55.243.4.20:/mnt/sfs_cap/e3aacef1e0be40559b38a5c2158aa62e_mqfb3ej839cdz7ub",
"mountPoint":"/mnt/test"
}
]
}
响应示例
{
"returnObj": {
"jobID": "os-aa99985e-e3b2-434f-9b29-5a77541a988c"
},
"details": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码