Help Center/ Media Processing Center/ API Reference/ Authorization and Configuration APIs/ Requesting OBS Authorization
Updated on 2024-03-14 GMT+08:00
Online Debugging
CLI Examples
View PDF

Requesting OBS Authorization

Function

Enables or disables OBS Authorization. After this function is enabled, MPC has the read and write permissions on all your buckets. OBS Authorization is not available for IAM users.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/agencies

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID .

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token

The token 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.

Authorization

No

String

Authentication information. This parameter is mandatory when AK/SK-based authentication is used.

X-Project_Id

No

String

Project ID. This parameter is mandatory when AK/SK-based authentication is used. It is same as the project ID in path parameters.

X-Sdk-Date

No

String

Time when the request is sent. This parameter is mandatory when AK/SK-based authentication is used.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

project_id

No

String

ID of the tenant who has an OBS authorization task

operate_type

Yes

String

Specifies the operation tag.

Value range: [CREATED, CANCELED]

  • CREATED: authorized

  • CANCELED: authorization canceled

Response Parameters

Status code: 403

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error description

Example Requests

Enables or disables OBS Authorization. After this function is enabled, MPC has the read and write permissions on all your buckets. OBS Authorization is not available for IAM users.

POST https://{endpoint}/v1/{project_id}/agencies

{
  "operate_type" : "CREATED"
}

Example Responses

Status code: 403

The OBS authorization status cannot be changed.

{
  "error_code" : "MPC.10223",
  "error_msg" : "An agency has been created."
}

Status Codes

Status Code

Description

204

The information is returned when the request succeeds.

403

The OBS authorization status cannot be changed.

Error Codes

See Error Codes.

Parent Topic: Authorization and Configuration APIs