数据库智能管家 DBbrain 获取邮件配置-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： dbbrain.tencentcloudapi.com 。

获取发送邮件的配置，包括数据库巡检的邮件配置以及定期生成健康报告的邮件发送配置。Region统一选择广州。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeMailProfile。
Version	是	String	公共参数，本接口取值：2019-10-16。
Region	是	String	公共参数，详见产品支持的地域列表。
ProfileType	是	String	配置类型，支持值包括："dbScan_mail_configuration" - 数据库巡检邮件配置，"scheduler_mail_configuration" - 定期生成邮件配置。示例值：scheduler_mail_configuration
Product	是	String	服务产品类型，支持值包括： "mysql" - 云数据库 MySQL， "cynosdb" - 云数据库 TDSQL-C for MySQL，默认为"mysql"。示例值：mysql
Offset	是	Integer	分页偏移量。示例值：0
Limit	是	Integer	分页单位，最大支持50。示例值：20
ProfileName	否	String	根据邮件配置名称查询，定期发送的邮件配置名称遵循："scheduler_"+{instanceId}的规则。示例值：scheduler_cdb-of66x11l

3. 输出参数

参数名称	类型	描述
ProfileList	Array of UserProfile	邮件配置详情。注意：此字段可能返回 null，表示取不到有效值。示例值：-
TotalCount	Integer	邮件模板总数。注意：此字段可能返回 null，表示取不到有效值。示例值：1
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取邮件配置

获取邮件配置。

输入示例

https://dbbrain.tencentcloudapi.com/?Action=DescribeMailProfile
&Product=mysql
&ProfileType=scheduler_mail_configuration
&Offset=0
&Limit=20
&<公共请求参数>

输出示例

{
    "Response": {
        "TotalCount": 1,
        "RequestId": "c7324330-5fc8-11eb-a3f4-96666666",
        "ProfileList": [
            {
                "ProfileId": "12345",
                "ProfileType": "dbScan_mail_configuration",
                "ProfileLevel": "User",
                "ProfileName": "测试uin",
                "ProfileInfo": {
                    "MailConfiguration": {
                        "HealthStatus": [
                            "HEALTH",
                            "SUB_HEALTH",
                            "RISK",
                            "HIGH_RISK"
                        ],
                        "Region": [
                            "ap-guangzhou"
                        ],
                        "ContactGroup": [],
                        "SendMail": 0,
                        "ContactPerson": [
                            123
                        ]
                    },
                    "Language": "zh"
                }
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InternalError	内部错误。
InvalidParameter	参数错误。
MissingParameter	缺少参数错误。

获取邮件配置

本页目录：