- 动态与公告
- 产品简介
- 购买指南
- 操作指南
- 实践教程
- API 文档
- History
- Introduction
- Introduction
- API Category
- Making API Requests
- Redis related APIs
- Health Report Email Sending APIs
- Exception Detection APIs
- Session Killing APIs
- Space Analysis APIs
- Slow Log Analysis APIs
- Security Audit APIs
- Database Audit APIs
- Other APIs
- Data Types
- Error Codes
- DBbrain APIs 2019-10-16
- 常见问题
- 服务等级协议
- 词汇表
- 联系我们
- 动态与公告
- 产品简介
- 购买指南
- 操作指南
- 实践教程
- API 文档
- History
- Introduction
- Introduction
- API Category
- Making API Requests
- Redis related APIs
- Health Report Email Sending APIs
- Exception Detection APIs
- Session Killing APIs
- Space Analysis APIs
- Slow Log Analysis APIs
- Security Audit APIs
- Database Audit APIs
- Other APIs
- Data Types
- Error Codes
- DBbrain APIs 2019-10-16
- 常见问题
- 服务等级协议
- 词汇表
- 联系我们
1. API Description
Domain name for API request: dbbrain.tencentcloudapi.com.
This API is used to create the email configuration. The input parameter ProfileType represents the type of the email configuration. Valid values: dbScan_mail_configuration (email configuration of database inspection report) and scheduler_mail_configuration (email sending configuration of scheduled task health report). Always select Guangzhou for Region, regardless of the region where the instance resides.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
2. Input Parameters
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: CreateMailProfile. |
| Version | Yes | String | Common Params. The value used for this API: 2021-05-27. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| ProfileInfo | Yes | ProfileInfo | Email configuration. |
| ProfileLevel | Yes | String | Configuration level. Valid values: User (user-level), Instance (instance-level). For database inspection emails, it should be User. For scheduled task emails, it should be Instance. |
| ProfileName | Yes | String | Configuration name, which needs to be unique. For database inspection emails, this name can be customized as needed. For scheduled task emails, the name should be in the format of "scheduler_" + {instanceId}, such as "schduler_cdb-test". |
| ProfileType | Yes | String | Configuration type. Valid values: dbScan_mail_configuration (email configuration of the database inspection report), scheduler_mail_configuration (email configuration of the scheduled task report). |
| Product | Yes | String | Service type. Valid values: mysql (TencentDB for MySQL), cynosdb (TDSQL-C for MySQL). |
| BindInstanceIds.N | No | Array of String | Instance ID bound with the configuration, which is set when the configuration level is Instance. Only one instance can be bound at a time. When the configuration level is User, leave this parameter empty. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Example
Example1 Creating an email sending template for scheduled task emails/database inspection emails
Input Example
https://dbbrain.tencentcloudapi.com/?Action=CreateMailProfile
&Product=mysql
&ProfileLevel=Instance
&ProfileName=scheduler_cdb-test
&ProfileType= scheduler_mail_configuration
&BindInstanceIds.0=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>
Output Example
{
"Response": {
"RequestId": "77db16d7-bbe8-48a7-868b-ed776a96f1ab"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
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. |
| FailedOperation | Operation failed. |
| InternalError | Internal error. |
| InvalidParameter | Incorrect parameter. |
| InvalidParameterValue | Incorrect parameter value. |
| LimitExceeded | The quota limit is exceeded. |
| MissingParameter | Missing parameter. |
| OperationDenied | Operation denied. |
| OperationDenied.UserHasNoStrategy | Error with CAM authentication. |
| ResourceNotFound | The resource does not exist. |
| UnauthorizedOperation | The operation is unauthorized. |
| UnknownParameter | Unknown parameter. |
| UnsupportedOperation | Unsupported operation. |
是
否
本页内容是否解决了您的问题？