Modifying the Scheduled Task Configuration of a Report (Topic Mode)
Function
Modify the scheduled task configuration of a report (topic mode).
URI
POST /v1/{project_id}/audit/{instance_id}/reports/task
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition Project ID. You can obtain the value by calling the IAM API for [querying the project list of a specified IAM user]. Constraints N/A Range The value is determined by the value of the IAM API. The value contains 32 to 64 characters. Default Value N/A |
instance_id |
Yes |
String |
Definition Instance ID. The value can be obtained from the ID field of the API for querying the instance list. Constraints N/A Range The value is determined by the value of the API for querying the instance list. The value contains 32 to 64 characters. Default Value N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition User token. The token can be queried by calling the IAM API. (The token is the value of X-Subject-Token in the response header.) Constraints N/A Range Determined by the value of the IAM API used for querying user tokens. Default Value N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
scheduler |
Yes |
SchedulerBean object |
Scheduling information. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
db_ids |
No |
String |
Database ID. |
format |
Yes |
String |
File type. The default value is ZIP. |
frequency |
Yes |
String |
Period |
id |
Yes |
String |
Template ID |
mode |
Yes |
String |
Scheduling mode. |
notice |
Yes |
String |
Whether to send notifications.
|
start_time |
Yes |
String |
Start time |
status |
Yes |
String |
Template status |
topic_urn |
Yes |
String |
Topic URN |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
status |
String |
Status.
|
Status code: 400
Parameter |
Type |
Description |
---|---|---|
details |
Array of DbssErrorDetail objects |
PDP5 authentication exception information |
encoded_authorization_message |
String |
PDP5 authentication exception information |
error_code |
String |
Error Codes |
error_msg |
String |
Error message. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error Codes |
error_msg |
String |
PDP5 error information |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
details |
Array of DbssErrorDetail objects |
PDP5 authentication exception information |
encoded_authorization_message |
String |
PDP5 authentication exception information |
error_code |
String |
Error Codes |
error_msg |
String |
Error message. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error Codes |
error_msg |
String |
PDP5 error information |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
details |
Array of DbssErrorDetail objects |
PDP5 authentication exception information |
encoded_authorization_message |
String |
PDP5 authentication exception information |
error_code |
String |
Error Codes |
error_msg |
String |
Error message. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error Codes |
error_msg |
String |
PDP5 error information |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
details |
Array of DbssErrorDetail objects |
PDP5 authentication exception information |
encoded_authorization_message |
String |
PDP5 authentication exception information |
error_code |
String |
Error Codes |
error_msg |
String |
Error message. |
Example Requests
/v1/{project_id}/audit/{instance_id}/reports/task { "scheduler" : { "status" : "OFF", "notice" : "ON", "mode" : "CYCLE", "start_time" : 17, "topic_urn" : "urn:smn:cn-north-7:b9351f98c724428794ba7d105fa3558d:SMN-JJH", "db_ids" : null, "id" : "HDIbD5YBZUbBN2XwhfrD", "frequency" : "AUDIT_REPORT_WEEK", "format" : "ZIP" } }
Example Responses
Status code: 200
OK
{ "status" : "success" }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
400 |
Invalid request parameter. |
401 |
Authorization failed. |
403 |
Unauthorized |
500 |
Server error. |
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