更新时间:2025-01-03 GMT+08:00

生成访问凭证信息

功能介绍

生成桶凭证信息。

调试

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

URI

POST /v1/{project_id}/app-center/buckets/actions/create-credential

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

表3 请求Body参数

参数

是否必选

参数类型

描述

file_name

String

文件完整名称,不允许包含如下字符:^;|~`{}[]<>。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

server_end_point

String

访问的服务终端节点。

bucket_name

String

存放的桶名称。

object_path

String

OBS对象路径。

注: path是对象在obs中的完整路径。

例如桶存在如下目录结构的数据。

Bucket:

├─dir1

| ├─object1.txt

| └─object2.txt

└─object3.txt

Object1的path: dir1/object1.txt

Object2的path: dir1/object2.txt

Object3的path: object3.txt

policy

ObsPolicy object

访问策略。

credential

ObsCredential object

对应的凭据信息。

表5 ObsPolicy

参数

参数类型

描述

version

String

版本号。

statement

ObsPolicyStatement object

obs桶存放的策略内容。

表6 ObsPolicyStatement

参数

参数类型

描述

effect

String

状态(正常、禁用):

  • 'Allow' - 允许

  • 'Deny' - 禁用

action

Array of strings

可以进行操作的权限合集。

resource

Array of strings

允许访问的资源。

表7 ObsCredential

参数

参数类型

描述

access

String

access key。

secret

String

secret key。

security_token

String

安全校验token。

状态码: 400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 401

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 403

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 404

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 405

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 500

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 503

表14 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

请求示例

{
  "file_name" : "xxx.exe"
}

响应示例

状态码: 200

成功响应。

{
  "server_end_point" : "obs.cn-north-xx.myhuaweicloud.com",
  "bucket_name" : "",
  "object_path" : "app-file/xxxx.exe",
  "policy" : {
    "version" : "1.1",
    "statement" : {
      "effect" : "Allow",
      "action" : [ "obs:object:PutObject" ],
      "resource" : [ "obs:*:*:object:file/xxx.exe" ]
    }
  },
  "credential" : {
    "access" : "nvfdjnvodfhnboidf923948390",
    "secret" : "nvfdjnvodfhnboidf923948390",
    "security_token" : "nvfdjnvodfhnboidf923948390"
  }
}

状态码

状态码

描述

200

成功响应。

400

由于包含语法错误,当前请求无法被服务器理解。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

405

请求中指定的方法不被允许。

500

服务内部错误,具体返回错误码请参见错误码说明。

503

服务不可用。

错误码

请参见错误码