Help Center> Data Lake Insight> API Reference> APIs Related to Flink Jobs> Granting OBS Permissions to DLI
View PDF

Granting OBS Permissions to DLI

Function

This API is used to grant DLI the permission to access OBS buckets for saving job checkpoints and run logs.

Debugging

You can debug this API in API Explorer.

URI

  • URI format

    POST /v1.0/{project_id}/dli/obs-authorize

  • Parameter description
    Table 1 URI parameters

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Project ID, which is used for resource isolation. For details about how to obtain its value, see Obtaining a Project ID.

Request

Table 2 Request parameters

Parameter

Mandatory

Type

Description

obs_buckets

Yes

Array of Strings

List of OBS buckets.

Response

Table 3 Response parameters

Parameter

Mandatory

Type

Description

is_success

No

Boolean

Whether the request is successfully executed. Value true indicates that the request is successfully executed.

message

No

String

Message content.

Example

  • Example request 
    {
    "obs_buckets": [
        "bucket1"
    ]
}
  • Example response 
    {
    "is_success": "true",
    "message": "The following OBS bucket is authorized successfully, bucket1."
}

Status Codes

Table 4 describes the status code.

Table 4 Status codes

Status Code

Description

200

Authorization succeeds.

400

Request error.

Error Codes

If an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see Error Code.