文档首页/ 云应用引擎 CAE/ API参考/ CAE API/ 云存储/ 授权云存储
更新时间：2025-10-22 GMT+08:00
查看PDF
分享

授权云存储

功能介绍

授权云存储。

URI

POST /v1/{project_id}/cae/volumes

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取项目ID请参见获取项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

  • 获取Token，请参考《统一身份认证服务API参考》的“获取用户Token”章节。

    • 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Enterprise-Project-ID

否

String

企业项目ID。

  • 创建环境时，环境会绑定企业项目ID。

  • 最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。

  • 该字段不传（或传为字符串“0”）时，则查询默认企业项目下的资源。

说明：
关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理服务用户指南》。

X-Environment-ID

是

String

环境ID。

  • 获取环境ID，通过获取环境列表来获取环境信息。

  • 请求响应成功后在响应体的items数组中的一个元素即为一个环境的信息，其中id字段即是环境ID。
表3 请求Body参数

参数

是否必选

参数类型

描述

api_version

是

String

API版本，固定值“v1”，该值不可修改。

kind

是

String

API类型，固定值“Volume”，该值不可修改。

spec

是

VolumeSpec object

volume规格信息。
表4 VolumeSpec

参数

是否必选

参数类型

描述

resource_type

是

String

资源类型，当前只支持“obs”和“sfs”。

resource_sub_type

是

String

对象存储类型。

resources

是

Array of strings

云存储名称。

resources_credentials

否

Array of ResourcesCredential objects

云存储和授权凭证，获取环境列表接口响应中env_category字段为v2时需添加该字段的值。
表5 ResourcesCredential

参数

是否必选

参数类型

描述

access

否

String

用户access key，当前access key应该包含访问授权云存储的权限。

secret

否

String

用户secret key，当前secret key应该包含访问授权云存储的权限。

响应参数

状态码：200

请求成功。

无

请求示例

授权云存储，云存储类型为“obs”，存储桶名称为“test-bucket”。

POST https://{endpoint}/v1/{project_id}/cae/volumes

{
  "api_version" : "v1",
  "kind" : "Volume",
  "spec" : {
    "resource_type" : "obs",
    "resource_sub_type" : "object_bucket",
    "resources" : [ "test-bucket" ],
    "resources_credentials" : [ {
      "access" : "xxx",
      "secret" : "xxx",
      "resources" : [ "test-bucket" ]
    } ]
  }
}

响应示例

无

状态码

状态码

描述

200

请求成功。

错误码

请参见错误码。

父主题： 云存储