Deze pagina is nog niet beschikbaar in uw eigen taal. We werken er hard aan om meer taalversies toe te voegen. Bedankt voor uw steun.
- Service Overview
- Getting Started
-
User Guide
- Process
- Roles and Permissions
- Preparing
- Creating Tasks
- (Optional) Configuring Rule Sets
-
(Optional) Configuring Tasks
- Overview
- Configuring Basic Info
- Configuring a Rule Set
- Configuring Excluded Flies
- Configuring Quality Gate
- Configuring Execution Plans
- Enabling and Disabling Notifications
- Configuring Check Modes
- Configuring an Automatic Check Task for Branch Merge
- Configuring an Automatic Check Task Executed upon Code Commit
- Executing Tasks
- Viewing Check Results
-
API Reference
- Before You Start
- API Overview
- Calling APIs
-
APIs
-
Task Management
- Querying the task list
- Stopping a Check Task
- Querying the Task Execution Status
- Querying Historical Scan Results
- Querying Check Parameters of a Task Rule Set (V2)
- Task Configuration Check Parameters
- Modifying a Task Rule Set
- Querying Task Check Failure Logs
- Creating a Check Task
- Deleting a Check Task
- Executing a Check Task
- Querying Check Parameters of a Task Rule Set (v3)
- Querying the Selected Rule Sets of a Task (V2)
- Querying the Selected Rule Sets of a Task (v3)
- Obtaining the Directory Tree of a Task
- Shielding a Directory in Task Configuration
- Querying Advanced Settings of a Task
- Configuring Advanced Settings for a Task
- Defect Management
- Rule Management
-
Task Management
- Application Examples
- Appendixes
- Change History
-
FAQs
-
General Issues
- What Are the Role Permissions in CodeArts Check?
- How Do I Use CodeArts Check?
- Which Languages Can Be Checked by CodeArts Check?
- Which of the Following Dimensions Can Be Checked by CodeArts Check?
- Can I Check Local Code Using CodeArts Check?
- Does CodeArts Check Only Check Bugs in Code Execution?
- Can I Locate the Code Committer for a Bug?
- Can I Select Multiple Rule Sets for a Code Check Task?
- How Do I Export Code Issues?
-
Using CodeArts Check
- Executing Task. Try Again Later
- Insufficient Permission. Please Check and Try Again
- Cppcheck Cannot Tokenize the Code Correctly
- No Data Is Displayed After a Task Check Is Complete
- Permission Is Insufficient for Using Public APIs
- A Message Is Displayed Indicating that the Project Does Not Exist When a Public API Is Used
- Setting Build Parameters
- Failed to Check a TypeScript Task
- Security
-
General Issues
Response
Status Code
After sending a request, you will receive a response that includes a status code, response header, and response body.
A status code is a group of digits, ranging from 1xx to 5xx. It indicates the status of a request. For details, see Status Codes.
For example, if status code 201 is returned for calling the API used to obtain a user token, the request is successful.
Response Header
Similar to a request, a response also has a header, for example, content-type.
Figure 1 shows the response header fields for the API used to obtain a user token. The x-subject-token header field is the desired user token. This token can then be used to authenticate requests for calling other APIs.
Response Body
A response body is often returned in structured format. It corresponds to content-type header field and passes content except the response header.
The following is part of the response body for the API used to obtain a user token. The following describes part of the request body.
{
"token": {
"expires_at": "2019-02-13T06:52:13.855000Z",
"methods": [
"password"
],
"catalog": [
{
"endpoints": [
{
"region_id": "eu-west-101",
......If an error occurs during API calling, an error code and the corresponding error message will be displayed. The following shows an error response body:
{
"error_msg": "The format of message is error",
"error_code": "AS.0001"
}In the preceding information, error_code is an error code, and error_msg describes the error.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
