Help Center/ Workspace/ API Reference/ Workspace APIs/ App Center/ Generating Access Credential Information

Updated on 2025-07-14 GMT+08:00

View PDF

Generating Access Credential Information

Function

Generates bucket credential information.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
file_name	Yes	String	Complete file name. Characters such as :^;\|~`{}[]<> are not allowed.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
server_end_point	String	Accessed service endpoint.
bucket_name	String	Name of the bucket for storage.
object_path	String	OBS object path. Note: path is the complete path of the object in OBS. For example, the bucket has the following directory structure: Bucket: ├─dir1 \| ├─object1.txt \| └─object2.txt └─object3.txt Path of object 1: dir1/object1.txt Path of object 2: dir1/object2.txt Path of object 3: object3.txt
policy	ObsPolicy object	Access policy.
credential	ObsCredential object	Corresponding credential information.

**Table 5** ObsPolicy
Parameter	Type	Description
version	String	Version number.
statement	ObsPolicyStatement object	OBS bucket storage policy.

**Table 6** ObsPolicyStatement
Parameter	Type	Description
effect	String	Status: Allow: allowed Deny: disallowed
action	Array of strings	All granted permissions.
resource	Array of strings	Accessible resource.

**Table 7** ObsCredential
Parameter	Type	Description
access	String	Access key.
secret	String	Secret key.
security_token	String	Security verification token.

Status code: 400

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Status code: 401

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Status code: 403

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Status code: 404

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Status code: 405

**Table 12** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Status code: 500

**Table 13** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Status code: 503

**Table 14** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Example Requests

{
  "file_name" : "xxx.exe"
}

Example Responses

Status code: 200

Response to a successful request.

{
  "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" : "nvf***********390",
    "secret" : "nvf***********390",
    "security_token" : "nvf***********390"
  }
}

Status Codes

Status Code	Description
200	Response to a successful request.
400	The request cannot be understood by the server due to malformed syntax.
401	Authentication failed.
403	No operation permissions.
404	No resources found.
405	The method specified in the request is not allowed.
500	An internal service error occurred. For details, see the error code description.
503	Service unavailable.