Querying Check Parameters of a Task Rule Set (V2)
Function
Querying Check Parameters of a Task Rule Set (V2)
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/tasks/{task_id}/ruleset/{ruleset_id}/check-parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID |
task_id |
Yes |
String |
Task ID. |
ruleset_id |
Yes |
String |
Rule Set ID |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
language |
Yes |
String |
Rule Set Language |
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 an IAM API. The value of X-Subject-Token in the response header is the user token. Minimum: 1 Maximum: 100000 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
[items] |
Array of TaskCheckParamters objects |
Request succeeded! |
Parameter |
Type |
Description |
---|---|---|
check_id |
Integer |
Check Tool ID |
name |
String |
Compilation Parameter Name |
checker_configs |
Array of CheckConfigInfo objects |
Checking Parameter Settings |
Parameter |
Type |
Description |
---|---|---|
name |
String |
Check the parameter name. |
cfg_key |
String |
Check the key value corresponding to the parameter. |
default_value |
String |
Checking the Default Value of a Parameter |
option_value |
String |
Check the optional parameters. |
is_required |
Integer |
0: optional; 1: mandatory |
description |
String |
Check Parameter Description |
type |
Integer |
Parameter type. The options are as follows: 0: text; 2: optional. |
status |
String |
Parameter status. The options are on (enabled) and off (disabled). |
value |
String |
Checks parameter values. |
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}/v2/{project_id}/tasks/{task_id}/ruleset/{ruleset_id}/check-parameters
Example Responses
Status code: 200
Request succeeded!
[ { "check_id" : 0, "name" : "compile_tool", "check_configs" : [ { "value" : "", "name" : "Command", "cfg_key" : "", "default_value" : "", "option_value" : "", "is_required" : 0, "description" : "Command", "type" : 0, "status" : "on" } ] } ]
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