文档首页/ 高性能弹性文件服务 SFS Turbo/ API参考/ 快速入门
更新时间：2024-11-13 GMT+08:00
查看PDF
分享

快速入门

本节通过调用SFS Turbo的API接口创建SFS Turbo文件系统，展示如何使用API接口。

通过IAM服务获取到的Token有效期为24小时，需要使用同一个Token鉴权时，可以先将Token缓存，避免频繁调用。

涉及API

当您使用Token认证方式完成认证鉴权时，需要获取用户Token并在调用接口时增加“X-Auth-Token”到业务接口请求消息头中。完成创建SFS Turbo文件系统的请求涉及如下API：

  • IAM获取token的API
  • 创建SFS Turbo文件系统的API，请参考《高性能弹性文件服务API参考》的“创建文件系统”。

具体步骤

  1. 获取Token，具体操作请参考认证鉴权 。
  2. 在Request Header中增加“X-Auth-Token”。
  3. 在Request Body中传入参数如下： 

    {
  "share": {
    "name": "sfs-turbo-test", 
    "share_proto": "NFS",
    "share_type": "STANDARD",
    "size": 100,
    "availability_zone": "az1", 
    "vpc_id": "d651ea2b-2b20-4c6d-8bbf-2adcec18dac9", 
    "subnet_id": "b8884abe-f47b-4917-9f6c-f64825c365db",
    "security_group_id": "8c4ebbd0-6edf-4aae-8353-81ce6d06e1f4"
  }
}

  4. 发送请求“POST https://SFS Turbo的Endpoint/v1/{project_id}/sfs-turbo/shares”。
  5. 请求响应成功后，返回SFS Turbo文件系统的id和name。

    若请求失败，则会返回错误码及对应的错误信息说明，详细错误码信息请参考对应API接口的异常返回值。

    根据返回的文件系统id查询SFS Turbo文件系统详情，具体操作请参考《高性能弹性文件服务API参考》的“查询文件系统详细信息”。

    查询文件系统详情返回状态status为“200”，则表示创建SFS Turbo文件系统成功。请求异常的返回值说明请参考对应API接口的异常返回值。其他的状态请参考SFS Turbo文件系统状态。

    根据文件系统的id，可对SFS Turbo文件系统进行查询、删除等操作。

具体示例

在已获取token的前提下，curl命令创建SFS Turbo文件系统的具体实例：

curl -k -i -X POST -H "X-Auth-Token: token_value" -H "Content-Type: application/json" -d '{"share": {"name": "sfs-turbo-test", "share_proto": "NFS", "share_type": "STANDARD", "size": 100, "availability_zone": "az1", "vpc_id": "d651ea2b-2b20-4c6d-8bbf-2adcec18dac9", "subnet_id": "b8884abe-f47b-4917-9f6c-f64825c365db", "security_group_id": "8c4ebbd0-6edf-4aae-8353-81ce6d06e1f4"}}' "https://127.0.0.1:8979/v1/xxxbxbex5cfx41f0a08ay915fd79240d/sfs-turbo/shares"