Help Center/Data Security Center/API Reference/API Description/Asset Management/Querying the Data Asset Scanning Authorization
Updated on 2023-12-07 GMT+08:00
View PDF

Querying the Data Asset Scanning Authorization

Function

This API is used to query the data asset scanning authorization.

URI

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

added

No

Boolean

Authorized

offset

No

Integer

Page number

limit

No

Integer

Page limit

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

buckets

Array of Bucket objects

OBS bucket list

total

Integer

Total number of OBS buckets

Table 4 Bucket

Parameter

Type

Description

asset_name

String

Asset name

bucket_location

String

Bucket location

bucket_name

String

Bucket name

bucket_policy

String

Bucket policy

create_time

Long

Time created

deleted

Boolean

Deleted or not

id

String

Bucket ID

is_deleted

Boolean

Deleted or not

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error Message

Example Requests

Query the data asset scanning authorization.

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

Example Responses

Status code: 200

Request sent

{
  "buckets" : [ {
    "bucket_name" : "xxxx",
    "bucket_location" : "xxxx",
    "create_time" : 1667379757698,
    "is_deleted" : false
  } ],
  "total" : 1
}

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.

Parent topic:Asset Management