Obtaining the Check Data of a Tenant

Function

This API is used to query the total number of issues and lines under a tenant based on the token.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
codeartscheck::listAllTasks	List	-	-	-	-

URI

GET /v1/tasks/code-sum-measures

Request Parameters

**Table 1** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. Obtain one by calling the IAM API Obtaining a User Token. The value of X-Subject-Token in the response header is a token. Constraints N/A Range The length is the value of [1-100000]. Default Value N/A

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
httpStatus	String	Definition: HTTP response status. Value range: OK: The request has been successfully processed, and the server returns the requested resource or operation result. ACCEPTED: The request has been accepted by the server, but the processing is not complete (usually used for asynchronous operations). INTERNAL_SERVER_ERROR: internal API exception. BAD_REQUEST: abnormal parameter verification.
result	CodeSumMeasures object	Definition Code metrics results.
status	String	Definition: API response status. Value range: success: successful response. error: response failed.

**Table 3** CodeSumMeasures
Parameter	Type	Description
codeLineCountSum	Long	Definition Total number of checked lines. Range ≥ 0
defectCountSum	Long	Definition Total number of checked issues. Range ≥ 0

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. Value range: N/A
error_msg	String	Definition: Error message. Value range: N/A

Status code: 401

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. Value range: N/A
error_msg	String	Definition: Error message. Value range: N/A

Example Requests

This API is used to obtain the check data of a tenant.

https://{endpoint}/v1/tasks/code-sum-measures

Example Responses

Status code: 200

The check data of a tenant is obtained.

{
  "httpStatus" : "OK",
  "status" : "success",
  "result" : {
    "codeLineCountSum" : 10427446095,
    "defectCountSum" : 120691137
  }
}

Status code: 400

A request error occurred.

{
  "error_code" : "CC.xxxxxxxx.400",
  "error_msg" : "Verify request parameter failed. Check whether the request parameters are correct."
}

Status code: 401

The permission is insufficient.

{
  "error_code" : "CC.00000003",
  "error_msg" : "Authentication information expired."
}

Status Codes

Status Code	Description
200	The check data of a tenant is obtained.
400	A request error occurred.
401	The permission is insufficient.

Error Codes

See Error Codes.

Parent Topic: Task Management

Previous topic: Obtaining Information About Notifications

Next topic: Obtaining Code Health Status

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot