本文导读

功能介绍
调试
URI
请求参数
响应参数
请求示例
响应示例
状态码
错误码

展开导读

文档首页/ 云应用引擎 CAE/ API参考/ CAE API/ 云存储/ 授权云存储

授权云存储

更新时间：2025-05-28 GMT+08:00

查看PDF

功能介绍

授权云存储。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

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，通过《云应用引擎API参考》的“获取环境列表”章节获取环境信息。请求响应成功后在响应体的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	请求成功。

错误码

请参见错误码。

父主题： 云存储

上一篇：获取云存储列表

下一篇：解绑云存储

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

盘古Doer提问云社区提问