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
Authentication
Requests for calling an API can be authenticated using either of the following methods:
- Token-based authentication: Requests are authenticated using a token.
- AK/SK-based authentication: Requests are authenticated by encrypting the request body using an AK/SK pair.
Token-based Authentication
NOTE:
The validity period of a token is 24 hours. When using a token for authentication, cache it to prevent frequently calling the IAM API used to obtain a user token.
A token is used to acquire temporary permissions. During API authentication using a token, the token is added to requests to get permissions for calling the API.
When calling the API to obtain a user token, you must set auth.scope in the request body to project.
{
"auth": {
"identity": {
"methods": [
"password"
],
"password": {
"user": {
"name": "username",
"password": "********",
"domain": {
"name": "domainname"
}
}
}
},
"scope": {
"project": {
"name": "xxxxxxxx"
}
}
}
}After a token is obtained, add field X-Auth-Token to the request header to specify the token when other APIs are called. For example, if the token is ABCDEFJ...., X-Auth-Token: ABCDEFJ.... can be added to a request as follows:
POST https://check.eu-west-101.myhuaweicloud.eu/v3/auth/tokens Content-Type: application/json X-Auth-Token: ABCDEFJ....
AK/SK-based Authentication
NOTE:
AK/SK-based authentication supports API requests with a body not larger than 12 MB. For API requests with a larger body, token-based authentication is recommended.
AK/SK-based authentication uses AK/SK to sign requests, and the signature is then added to request headers for authentication.
- AK: access key ID. It is a unique ID associated with an SK. AK is used together with SK to sign requests.
- SK: secret access key. It is used together with an access key ID to identify a sender who initiates a request and to cryptographically sign requests, preventing the request from being modified.
NOTICE:
The signing SDK is only used for signing requests and is different from the SDKs provided by services.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
