Help Center/ Video On Demand/ API Reference/ Uploads media files/ Authorizing Access to an OBS Bucket
Updated on 2024-12-04 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Authorizing Access to an OBS Bucket

Function

Authorizes VOD to access an OBS bucket or cancels the authorization

URI

PUT /v1.0/{project_id}/asset/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.

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 a 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.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

bucket

Yes

String

OBS bucket name

operation

Yes

String

Whether to authorize access to buckets

Possible values are:

  • 0: The authorization is canceled.

  • 1: Access is authorized.

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

Grants or cancels the permission of VOD on OBS buckets.

PUT https://{endpoint}/v1.0/{project_id}/asset/authority

Content-Type: application/json
{
  "bucket": "bucket",
  "operation": "1"
}

Example Responses

Status code: 403

The information is returned when the request fails.

{
  "error_code" : "VOD.10053",
  "error_msg" : "The request parameter is illegal, illegal field: {xx}."
}

Status Codes

Status Code

Description

200

The information is returned when the request succeeds.

403

The information is returned when the request fails.

Error Codes

See Error Codes.

Parent topic: Uploads media files