Help Center/ Live/ Cloud Live API Reference/ OBS Bucket Management/ Granting or Canceling Authorization of Accessing OBS Buckets
Updated on 2025-11-06 GMT+08:00

Granting or Canceling Authorization of Accessing OBS Buckets

Function

API for granting or canceling authorization of accessing OBS buckets.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

PUT /v1/{project_id}/obs/authority

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. This parameter is mandatory when token authentication is used. 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 for AK/SK authentication.

X-Sdk-Date

No

String

Time when the request is sent. This parameter is mandatory for AK/SK authentication.

X-Project-Id

No

String

Project ID. This parameter is mandatory for AK/SK authentication.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

bucket

Yes

String

OBS bucket name

operation

Yes

Integer

Operation

  • 1: Access is authorized.

  • 0: The authorization is canceled.

Response Parameters

Status code: 200

Authorization of accessing OBS buckets updated.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error description

Example Requests

Modifies the authorization policy of the OBS bucket. The bucket name is video-test02 and the operation is Authorize.

PUT https://{endpoint}/v1/${project_id}/obs/authority

{
  "bucket" : "video-test02",
  "operation" : 1
}

Example Responses

Status code: 400

Update the authorization of accessing OBS buckets failed.

{
  "error_code" : "LIVE.100011001",
  "error_msg" : "Request Illegal"
}

Status Codes

Status Code

Description

200

Authorization of accessing OBS buckets updated.

400

Update the authorization of accessing OBS buckets failed.

Error Codes

See Error Codes.