CreateMailProfile

Prev Next

search by keyword

Recent Pages

Documentation

Download PDF

Last updated: 2021-07-13 17:27:47

Download PDF

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 regularly generated health report). Select Guangzhou for Region, regardless of the region where the instance belongs.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: dbbrain.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: CreateMailProfile.
Version	Yes	String	Common parameter. The value used for this API: 2019-10-16.
Region	Yes	String	Common parameter. For more information, please see the list of regions supported by the product.
ProfileInfo	Yes	ProfileInfo	Email configurations
ProfileLevel	Yes	String	Configuration level. Valid values: "User" (user-level), "Instance" (instance-level). For database inspection report, it should be `User`; and for scheduled task reports, it should be `Instance`.
ProfileName	Yes	String	Configuration name, which needs to be unique. For database inspection reports, this name can be customize as needed. For scheduled task reports, 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 database inspection report), "scheduler_mail_configuration" (email configuration of scheduled task report).
Product	Yes	String	Service type. Valid values: `mysql` (TencentDB for MySQL), `cynosdb` (TencentDB for CynosDB (compatible with 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 template to send the report generated by the scheduled task/database inspection

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.

Command Line Interface

Tencent Cloud CLI 3.0

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.
MissingParameter	Missing parameter.
OperationDenied	Operation denied.
OperationDenied.UserHasNoStrategy	Error with CAM authentication.
UnauthorizedOperation	The operation is unauthorized.
UnknownParameter	Unknown parameter.

Recent Pages