Querying Overview of the Latest Successful Governance Check Results

Function

This API is used to query the overview of the latest successful governance maturity check results.

URI

GET https://{endpoint}/v1/best-practice/detection-overview

Request Parameters

None

Response Parameters

Status code: 200

**Table 1** Response body parameters
Parameter	Type	Description
total_score	Number	Overall governance score.
detect_time	String	Time when the check was completed.
organization_account	BestPracticeOverviewItem object	Summary of check results for a domain against the best practices.
identity_permission	BestPracticeOverviewItem object	Summary of check results for a domain against the best practices.
network_planning	BestPracticeOverviewItem object	Summary of check results for a domain against the best practices.
compliance_audit	BestPracticeOverviewItem object	Summary of check results for a domain against the best practices.
financial_governance	BestPracticeOverviewItem object	Summary of check results for a domain against the best practices.
data_boundary	BestPracticeOverviewItem object	Summary of check results for a domain against the best practices.
om_monitor	BestPracticeOverviewItem object	Summary of check results for a domain against the best practices.
security_management	BestPracticeOverviewItem object	Summary of check results for a domain against the best practices.

**Table 2** BestPracticeOverviewItem
Parameter	Type	Description
score	Number	Score.
detection_count	Integer	Number of check items.
high_risk_count	Integer	Number of high-risk items.
medium_risk_count	Integer	Number of medium-risk items.
low_risk_count	Integer	Number of low-risk items.
risk_item_description	Array of strings	Risk description.

Status code: 403

**Table 3** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
request_id	String	Unique ID of the request.
encoded_authorization_message	String	Encrypted error message.
details	Array of ForbiddenErrorDetail objects	Error message indicating no permissions for cross-service invoking.

**Table 4** ForbiddenErrorDetail
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests

Querying the overview of the latest successful governance maturity check results

GET https://{endpoint}/v1/best-practice/detection-overview

Example Responses

Status code: 200

Request sent.

{
  "total_score" : 50,
  "detect_time" : "string",
  "organization_account" : [ {
    "score" : 50,
    "detection_count" : 0,
    "high_risk_count" : 0,
    "medium_risk_count" : 0,
    "low_risk_count" : 0,
    "risk_item_description" : [ ]
  } ],
  "identity_permission" : [ {
    "score" : 50,
    "detection_count" : 0,
    "high_risk_count" : 0,
    "medium_risk_count" : 0,
    "low_risk_count" : 0,
    "risk_item_description" : [ ]
  } ],
  "network_planning" : [ {
    "score" : 50,
    "detection_count" : 0,
    "high_risk_count" : 0,
    "medium_risk_count" : 0,
    "low_risk_count" : 0,
    "risk_item_description" : [ ]
  } ],
  "compliance_audit" : [ {
    "score" : 50,
    "detection_count" : 0,
    "high_risk_count" : 0,
    "medium_risk_count" : 0,
    "low_risk_count" : 0,
    "risk_item_description" : [ ]
  } ],
  "financial_governance" : [ {
    "score" : 50,
    "detection_count" : 0,
    "high_risk_count" : 0,
    "medium_risk_count" : 0,
    "low_risk_count" : 0,
    "risk_item_description" : [ ]
  } ],
  "data_boundary" : [ {
    "score" : 50,
    "detection_count" : 0,
    "high_risk_count" : 0,
    "medium_risk_count" : 0,
    "low_risk_count" : 0,
    "risk_item_description" : [ ]
  } ],
  "om_monitor" : [ {
    "score" : 50,
    "detection_count" : 0,
    "high_risk_count" : 0,
    "medium_risk_count" : 0,
    "low_risk_count" : 0,
    "risk_item_description" : [ ]
  } ],
  "security_management" : [ {
    "score" : 50,
    "detection_count" : 0,
    "high_risk_count" : 0,
    "medium_risk_count" : 0,
    "low_risk_count" : 0,
    "risk_item_description" : [ ]
  } ]
}