Updated on 2022-12-29 GMT+08:00

Adding a Data Asset Scanning Authorization

Function

This API is used to add a data asset scanning authorization.

URI

POST /v1/{project_id}/sdg/asset/obs/buckets

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

type

No

String

Asset type

Request Parameters

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

buckets

No

Array of BucketBean objects

OBS bucket list

Table 4 BucketBean

Parameter

Mandatory

Type

Description

asset_name

No

String

Asset name

location

No

String

Bucket location

bucket_name

No

String

Bucket name

bucket_policy

No

String

Bucket policy

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

msg

String

Returned message

status

String

Return status, for example, '200', '400'.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error Message

Example Requests

Add a data asset scanning authorization.

POST /v1/{project_id}/sdg/asset/obs/buckets

{
  "buckets" : [ {
    "asset_name" : "xxxx",
    "bucket_location" : "xxxx",
    "bucket_name" : "xxxx",
    "bucket_policy" : "private"
  } ]
}

Example Responses

Status code: 200

Request sent

{
  "msg" : "xxxx",
  "status" : "RESPONSE_SUCCESS"
}

Status code: 400

Invalid request

{
  "error_code" : "dsc.40000011",
  "error_msg" : "Invalid parameter"
}

Status Codes

Status Code

Description

200

Request sent

400

Invalid request

Error Codes

See Error Codes.