Help Center/ Media Processing Center/ API Reference/ Authorization and Configuration APIs/ Querying the Status of OBS Authorization Task Creation
Updated on 2023-12-25 GMT+08:00

Querying the Status of OBS Authorization Task Creation

Function

Queries the status of creating an OBS authorization task.

Calling Method

For details, see Calling APIs.

URI

GET /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.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

operate_type

String

Specifies the operation tag.

Value range: [CREATED, CANCELED]

  • CREATED: authorized

  • CANCELED: authorization canceled

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error description

Example Requests

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

Example Responses

Status code: 200

The status of creating an OBS authorization task has been queried.

{
  "operate_type" : "CREATED"
}

Status Codes

Status Code

Description

200

The status of creating an OBS authorization task has been queried.

400

The status of creating an OBS authorization task cannot be queried.

Error Codes

See Error Codes.