Domain name for API request: dbbrain.tencentcloudapi.com.
This API is used to get the email sending configuration, including the email configuration for database inspection and the email sending configuration for scheduled task health reports.
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: DescribeMailProfile. |
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. |
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). Default value: mysql . |
Offset | Yes | Integer | Pagination offset. |
Limit | Yes | Integer | Number of results per page in paginated queries. Maximum value: 50 . |
ProfileName | No | String | Query by email configuration name. The name of the scheduled task email configuration should be in the format of "scheduler_"+{instanceId}. |
Parameter Name | Type | Description |
---|---|---|
ProfileList | Array of UserProfile | Email configuration details. Note: This field may return null, indicating that no valid values can be obtained. |
TotalCount | Integer | Total number of the configured emails. Note: This field may return null, indicating that no valid values can be obtained. |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://dbbrain.tencentcloudapi.com/?Action=DescribeMailProfile
&Product=mysql
&ProfileType=scheduler_mail_configuration
&Offset=0
&Limit=20
&<Common request parameters>
{
"Response": {
"TotalCount": 1,
"RequestId": "c7324330-5fc8-11eb-a3f4-96666666",
"ProfileList": [
{
"ProfileId": "12345",
"ProfileType": "dbScan_mail_configuration",
"ProfileLevel": "User",
"ProfileName": "Test uin",
"ProfileInfo": {
"MailConfiguration": {
"HealthStatus": [
"HEALTH",
"SUB_HEALTH",
"RISK",
"HIGH_RISK"
],
"Region": [
"eu-moscow"
],
"ContactGroup": [],
"SendMail": 0,
"ContactPerson": [
123
]
},
"Language": "zh"
}
}
]
}
}
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. |
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. |
Was this page helpful?