Help Center> Cloud Stream Service> API Reference> APIs> APIs Related to Job Management> Granting OBS Operation Rights to CS
View PDF

Granting OBS Operation Rights to CS

Function

This API allows users to proactively grant operation rights on OBS buckets to CS to save checkpoint setting and run logs of users' jobs.

URI

  • URI format

    POST /v1.0/{project_id}/obs_authorize

  • Parameter description
    Table 1 URI parameter description

    Parameter

    Mandatory

    Description

    project_id

    Yes

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

Request

Grant read and write permissions on OBS buckets to CS. The settings of related request parameters are in JSON format.

  • Example request 
    ["bucket1"]
  • Parameter description
    Table 2 Request parameter

    Parameter

    Mandatory

    Type

    Description

    buckets

    No

    String

    List of OBS buckets.

Response

  • Example response 
    {
"message_id": "CS.10001",
"message": "Message content",
  "current_time": 1533686888000
}
  • Parameter description
    Table 3 Response parameters

    Parameter

    Mandatory

    Type

    Description

    message_id

    No

    String

    Message type ID.

    message

    No

    String

    Message content.

    current_time

    No

    Int

    Current time, expressed by milliseconds.

Status Code

Table 4 describes the status code.

Table 4 Status code

Status Code

Description

200

Authorization succeeds.

400

The input parameters are invalid.

Error Code

For details, see Error Codes.