Domain name for API request: dbbrain.intl.tencentcloudapi.com.
This API is used to create the regular generation time of the health reports and the regular email sending configuration. Pass in the regular generation time of the health reports as a parameter (Monday to Sunday) to set the regular generation time of the health reports, and save the corresponding regular email sending configuration.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
Parameter Name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common Params. The value used for this API: CreateSchedulerMailProfile. |
Version | Yes | String | Common Params. The value used for this API: 2019-10-16. |
Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
WeekConfiguration.N | Yes | Array of Integer | Value range: 1-7, representing Monday to Sunday respectively. |
ProfileInfo | Yes | ProfileInfo | Email configurations |
ProfileName | Yes | String | Configuration name, which needs to be unique. For scheduled task reports, the name should be in the format of "scheduler_" + {instanceId}, such as "schduler_cdb-test". |
BindInstanceId | Yes | String | Configure the instance ID that you need to generate the health report. |
Product | Yes | String | Service type. Valid values: mysql (TencentDB for MySQL), cynosdb (TDSQL-C for MySQL). Default value: mysql . |
Parameter Name | Type | Description |
---|---|---|
RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to create the configurations for regularly generating health reports and sending them via email. Pass in the regular generation time of the health reports as a parameter (Monday to Sunday) to set the regular generation time of the health reports, and save the corresponding regular email sending configuration.
https://dbbrain.intl.tencentcloudapi.com/?Action=CreateSchedulerMailProfile
&WeekConfiguration.0=1
&Product=mysql
&ProfileName=scheduler_cdb-test
&BindInstanceId=cdb-test
&ProfileInfo.Language=zh
&ProfileInfo.MailConfiguration.SendMail=1
&ProfileInfo.MailConfiguration.Region.0=ap-guangzhou
&ProfileInfo.MailConfiguration.HealthStatus.0=HEALTH
&ProfileInfo.MailConfiguration.ContactPerson.0=1
&ProfileInfo.MailConfiguration.ContactGroup.0=1
&<common request parameters>
{
"Response": {
"RequestId": "77db16d7-bbe8-48a7-868b-ed776a96f1ab"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
AuthFailure | Error with CAM signature/authentication. |
InternalError | Internal error. |
InvalidParameter | Incorrect parameter. |
InvalidParameterValue | Incorrect parameter value. |
MissingParameter | Missing parameter. |
OperationDenied | Operation denied. |
OperationDenied.UserHasNoStrategy | Error with CAM authentication. |
RequestLimitExceeded | The number of requests exceeds the frequency limit. |
UnknownParameter | Unknown parameter. |
UnsupportedOperation | Unsupported operation. |
Was this page helpful?