Help Center/ Data Security Center/ API Reference (ME-Abu Dhabi Region)/ API Description/ Sensitive Data Discovery/ Querying the OBS Bucket Lineage Graph
Updated on 2022-12-29 GMT+08:00
View PDF
Share

Querying the OBS Bucket Lineage Graph

Function

This API is used to query the OBS bucket lineage graph.

URI

GET /v1/{project_id}/sdg/server/relation/jobs/{job_id}/obs/buckets

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

job_id

Yes

String

Task ID
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

assets_name

No

String

Asset name

risk_start

Yes

Integer

Start risk level

risk_end

Yes

Integer

End risk level

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

total

Integer

Total number of relationships

bucket_list

Array of RelationSimpleInfo objects

Relationship list
Table 4 RelationSimpleInfo

Parameter

Type

Description

id

String

Relationship ID

name

String

Relationship name

path

String

Relationship path

risk_level

Integer

Risk level

type

String

Relationship type

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 OBS bucket lineage graph.

GET /v1/{project_id}/sdg/server/relation/jobs/{job_id}/obs/buckets

Example Responses

Status code: 200

Request sent

{
  "bucket_list" : [ {
    "id" : "xxxxxxxxxxxx",
    "name" : "xxxx",
    "path" : "xxxxxxxxxxxx",
    "risk_level" : 2,
    "type" : "BUCKET"
  } ],
  "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: Sensitive Data Discovery