接口功能介绍
此接口提供用户实现云主机挂载一个或多个文件系统的功能
准备工作:
构造请求:在调用前需要了解如何构造请求,详情查看构造请求
认证鉴权:openapi请求需要进行加密调用,详细查看认证鉴权
接口约束
1. 云主机须处于运行状态
2. 云主机和文件系统应属于同一个VPC
3. 云主机最多可挂载5个文件
4. 云主机仅支持部分镜像类型挂载,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/attach
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以查看地域和可用区来了解资源池 获取: 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
instanceID | 是 | String | 云主机ID,您可以查看弹性云主机了解云主机的相关信息 获取: 查 查询云主机列表 创 创建一台按量付费或包年包月的云主机 创 批量创建按量付费或包年包月云主机 |
b67b7f1f-095b-1249-b379-8dd5cc542a05 | |
sysInfoList | 是 | Array of Objects | 所绑定的文件系统详细信息 | sysInfoList |
表 sysInfoList
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
fileSysID | 是 | String | 文件系统id | 56644622-41d1-5c35-8794-df55bffaff88 | |
fileSysRoute | 是 | String | 文件系统地址(固定值,每一个文件都有相对应的文件系统地址) | 55.243.4.20:/mnt/sfs_cap/e3aacef1e0be40559b38a5c2158aa62e_mqfb3ej839cdz7ub | |
mountPoint | 是 | String | 挂载点,即:本地挂载路径(云主机上用于挂载文件系统的本地路径) linux镜像云主机使用限制: 1、单目录的长度不超过255个字符,总长度不能超过4095个字符; 2、必须以/开头,由数字,字母,点,下划线,减号组成,通过/(斜杠)分割 3、不能是系统路径:/, /bin, /usr, /boot, /dev, /etc, /lib, /lib64, /proc, /run, /sys, /var,/tmp,/sbin 推荐在/mnt下新建本地路径作为挂载路径,如:/mnt/docs. windows镜像云主机实用限制: 只能输入E~Z(大写)内的单个字母作为盘符 |
/mnt/docs | |
option | 是 | String | 挂载参数: linux云主机对应两个挂载参数(vers表示文件系统版本,可选3和4,建议取值3)vers=3,async,nolock,noatime,nodiratime,wsize=1048576,rsize=1048576,timeo=600 vers=4,async,nolock,noatime,nodiratime,wsize=1048576,rsize=1048576,timeo=600 windows云主机对应一个挂载参数:net use 注: 当linux云主机的协议类型选择NFSv3时,对应的option为vers3,当其协议类型选择NFSv4时,option应选vers4(即 protocol和option为对应关系) windows云主机的协议类型CIFS,对应的option为:net use |
vers=3,async,nolock,noatime,nodiratime,wsize=1048576,rsize=1048576,timeo=600 | |
autoMount | 否 | Boolean | 是否开机自动挂载(true/false),当云主机重启时会自动挂载文件系统,默认为false | false | |
protocol | 是 | String | 文件协议类型,linux协议类型为:NFSv3、NFSv4,windows协议类型为:CIFS | NFSv3 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
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":"2195b2af-c3b9-4b81-8d7d-88e0cc04a253",
"sysInfoList":[
{
"fileSysID":"56644622-41d1-5c35-8794-df55bffaff88",
"fileSysRoute":"55.243.4.20:/mnt/sfs_cap/e3aacef1e0be40559b38a5c2158aa62e_mqfb3ej839cdz7ub",
"mountPoint":"/mnt/docs",
"option":"vers=3,async,nolock,noatime,nodiratime,wsize=1048576,rsize=1048576,timeo=600",
"autoMount":false,
"protocol":"NFSv3"
}
]
}
示例2:云主机同时挂载多个文件系统
{
"regionID":"7f8653e8657d11edbb550242ac110006",
"instanceID":"d1e21b53-54d3-4a8b-af2b-215f823ca7ce",
"sysInfoList":[
{
"fileSysID":"56644622-41d1-5c35-8794-df55bffaff88",
"fileSysRoute":"55.243.4.20:/mnt/sfs_cap/e3aacef1e0be40559b38a5c2158aa62e_mqfb3ej839cdz7ub",
"mountPoint":"/mnt/docs/test1012",
"option":"vers=4,async,nolock,noatime,nodiratime,wsize=1048576,rsize=1048576,timeo=600",
"autoMount":true,
"protocol":"NFSv4"
},
{
"fileSysID":"8c7eff01-1a5e-5e16-90a5-dffbd9a7a35f",
"fileSysRoute":"55.243.4.20:/mnt/sfs_perf/e3aacef1e0be40559b38a5c2158aa62e_1qscdpa8t17fuv6r",
"mountPoint":"/mnt/docs/test1020",
"option":"vers=3,async,nolock,noatime,nodiratime,wsize=1048576,rsize=1048576,timeo=600",
"autoMount":true,
"protocol":"NFSv3"
}
]
}
响应示例
{
"returnObj": {
"jobID": "os-6e9f22ec-fef1-4ee3-88ae-fde539d991b6"
},
"details": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码