tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeMailProfile

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

1. API Description

Domain name for API request: dbbrain.tencentcloudapi.com.

This API is used to obtain the email sending configurations, including the email configuration for database inspection and the email sending configuration for regularly generated health reports. Select Guangzhou for Region.

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: DescribeMailProfile.
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.
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 (TDSQL-C for MySQL). Default value: mysql.
Offset Yes Integer Pagination offset
Limit Yes Integer The number of results per page in paginated queries. Maximum value: 50
ProfileName No String Query by the name of email configuration. The name of the regularly sent email configuration should be in the format of "scheduler_"+{instanceId}.

3. Output Parameters

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 email templates
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.

4. Example

Example1 Obtaining email configuration

Input Example

https://dbbrain.tencentcloudapi.com/?Action=DescribeMailProfile
&Product=mysql
&ProfileType=scheduler_mail_configuration
&Offset=0
&Limit=20
&<common request parameters>

Output Example

{
    "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"
                }
            }
        ]
    }
}

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

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
InternalError Internal error.
InvalidParameter Incorrect parameter.
MissingParameter Missing parameter.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy