Querying the OBS File Linage Graph in Pages
Function
This API is used to query the OBS file linage graph in pages.
URI
GET /v1/{project_id}/sdg/server/relation/jobs/{job_id}/obs/{bucket_id}/files
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID |
job_id |
Yes |
String |
Task ID |
bucket_id |
Yes |
String |
Bucket ID |
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 |
Yes |
Integer |
Offset |
size |
Yes |
Integer |
Page size |
limit |
No |
Integer |
Page limit |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
total |
Integer |
Total number of relationships |
current_page |
Integer |
Current page |
file_list |
Array of RelationSimpleInfo objects |
Relationship list |
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
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error Code |
error_msg |
String |
Error Message |
Example Requests
Query the OBS file linage graph in pages.
GET /v1/{project_id}/sdg/server/relation/jobs/{job_id}/obs/{bucket_id}/files
Example Responses
Status code: 200
Request sent
{ "file_list" : [ { "id" : "xxxxxxxxxxxx", "name" : "xxxx", "path" : "xxxxxxxxxxxx", "risk_level" : 2, "type" : "BUCKET" } ], "current_page" : 0, "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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot