Querying Advanced Settings of a Task
Function
Advanced settings of a query task.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/tasks/{task_id}/settings
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
task_id |
Yes |
String |
Task ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
offset |
No |
Integer |
(Optional) Offset for pagination. Minimum: 0 Default: 0 |
limit |
No |
Integer |
(Optional) Number of records displayed on each page. Minimum: 1 Maximum: 1000 Default: 10 |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
Content-Type |
Yes |
String |
Media type and encoding format. |
X-Auth-Token |
Yes |
String |
Can be obtained by calling the IAM API for obtaining the user token (the value of X-Subject-Token in the response header). Minimum: 1 Maximum: 100000 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
info |
Array of TaskAdvancedSettings objects |
Information about an advanced setting. |
total |
Integer |
Total number. |
Parameter |
Type |
Description |
---|---|---|
key |
String |
Name of an advanced setting. |
value |
String |
Value of an advanced setting. |
option_value |
String |
Options for an advanced setting. |
description |
String |
Description of an advanced setting. |
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}/settings
Example Responses
Status code: 200
Request succeeded!
{ "info" : [ { "key" : "customImage", "value" : "xxxxx", "description" : "Custom image.", "option_value" : "" } ], "total" : 1 }
Status code: 400
Bad Request
{ "error_code" : "CC.00000000", "error_msg" : "Network busy. Try again later." }
Status code: 401
Unauthorized
{ "error_code" : "CC.00000003", "error_msg" : "Authentication information 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