Querying Top 5 Asset Catalogs
Function
This API is used to query the first five asset catalogs. You can filter classification results by label ID and type ID to quickly learn the classification distribution of the asset catalog.
Calling Method
For details, see Calling APIs.
URI
GET /v1/{project_id}/metadata/catalog/classification-tops
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Unique project ID. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
label_id |
No |
String |
Label ID, which is used to filter classification results of a specific label. |
|
type_id |
No |
String |
Type ID, which is used to filter classification results of a specific type. |
Request Parameters
None
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
detection_classifications |
Array of ClassificationRule objects |
List of detected classification list. |
|
Parameter |
Type |
Description |
|---|---|---|
|
classification_name |
String |
Classification name. |
|
column_details |
Array of ColumnInfoAndMatchInfo objects |
Column details list. |
|
hit_number |
Integer |
Matched items. |
|
Parameter |
Type |
Description |
|---|---|---|
|
asset_id |
String |
Asset ID. |
|
asset_name |
String |
Asset name. |
|
column_fqn |
String |
Fully qualified name (FQN) of the column. |
|
db_type |
String |
Database type. |
|
match_infos |
Array of ClassificationMatchInfo objects |
List of matching information. |
|
Parameter |
Type |
Description |
|---|---|---|
|
classification_id |
String |
Classification ID. |
|
classification_name |
String |
Classification name. |
|
match_content_cnt |
Integer |
Number of matched content items. |
|
match_rate |
Double |
Matching rate (%). |
|
matched_detail |
String |
Matching details. |
|
matched_examples |
Array of MatchedExamples objects |
List of matching examples. |
|
rule_id |
String |
Rule ID. |
|
rule_name |
String |
Rule name. |
|
security_level_color |
Integer |
Security level color (RGB value). |
|
security_level_id |
String |
Security level ID. |
|
security_level_name |
String |
Security level name. |
|
template_id |
String |
Template ID. |
|
template_name |
String |
Template name. |
Example Requests
None
Example Responses
None
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Query result. |
|
401 |
Unauthorized. The user is not logged in or the token is invalid. |
|
403 |
Unauthorized to access the resource. |
|
404 |
The specified project does not exist. |
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