Querying the Selected Rule Sets of a Task (v3)
Function
This API is used to query the selected rule set list (v3) of a task.
Calling Method
For details, see Calling APIs.
URI
GET /v3/{project_id}/tasks/{task_id}/rulesets
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID |
task_id |
Yes |
String |
Task ID |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
offset |
No |
Integer |
Pagination index, offset Minimum: 0 Default: 0 |
limit |
No |
Integer |
Number of records displayed on each page. A maximum of 1000 records can be displayed on each page. Minimum: 1 Maximum: 1000 Default: 10 |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
Content-Type |
No |
String |
Setting the Media Type and Encoding Format |
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header). Minimum: 1 Maximum: 100000 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
info |
Array of TaskRulesetInfo objects |
Rule Set Information |
total |
Integer |
Total |
Parameter |
Type |
Description |
---|---|---|
template_id |
String |
Rule Set ID |
language |
String |
Rule Set Language |
template_name |
String |
Rule Set |
type |
String |
Rule set status. The options are as follows: optional; selected. |
status |
String |
Rule set attribute. The value 0 indicates the default user rule set, and the value 1 indicates the default system rule set. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error Codes |
error_msg |
String |
Description |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error Codes |
error_msg |
String |
Description |
Example Requests
GET https://{endpoint}/v3/{project_id}/tasks/{task_id}/rulesets
Example Responses
Status code: 200
Request succeeded!
{ "total" : 1, "data" : [ { "template_id" : "111111xxxx3246", "language" : "java", "type" : "selected", "template_name" : "General check rule set", "status" : "1" } ] }
Status code: 400
Bad Request
{ "error_code" : "CC.00000000", "error_msg" : "The network is busy. Please try again later." }
Status code: 401
Unauthorized
{ "error_code" : "CC.00000003", "error_msg" : "The authentication information has expired." }
Status Codes
Status Code |
Description |
---|---|
200 |
Request succeeded! |
400 |
Bad Request |
401 |
Unauthorized |
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