数据库智能管家 DBbrain 创建健康报告生成任务-API 文档-文档中心-腾讯云

1. 接口描述

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

创建健康报告，并可以选择是否发送邮件。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateDBDiagReportTask。
Version	是	String	公共参数，本接口取值：2021-05-27。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	是	String	实例ID。示例值：test
StartTime	是	Timestamp ISO8601	开始时间，如“2020-11-08T14:00:00+08:00”。示例值：2019-01-01T00:00:00+08:00
EndTime	是	Timestamp ISO8601	结束时间，如“2020-11-09T14:00:00+08:00”。示例值：2019-01-02T00:00:00+08:00
SendMailFlag	是	Integer	是否发送邮件: 0 - 否，1 - 是。示例值：1
ContactPerson.N	否	Array of Integer	接收邮件的联系人ID数组。示例值：["1\n"]
ContactGroup.N	否	Array of Integer	接收邮件的联系组ID数组。示例值：["1\n"]
Product	否	String	服务产品类型，支持值包括： "mysql" - 云数据库 MySQL， "cynosdb" - 云数据库 CynosDB for MySQL，默认值为"mysql"。示例值：mysql

3. 输出参数

参数名称	类型	描述
AsyncRequestId	Integer	异步任务的请求 ID，可使用此 ID 查询异步任务的执行结果。注意：此字段可能返回 null，表示取不到有效值。示例值：129632
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建健康报告, 发送邮件(可选)

输入示例

https://dbbrain.tencentcloudapi.com/?Action=CreateDBDiagReportTask
&InstanceId=test
&StartTime=2019-01-01T00:00:00+08:00
&EndTime=2019-01-02T00:00:00+08:00
&SendMailFlag=1
&ContactPerson.0=1
&ContactGroup.0=1
&<公共请求参数>

输出示例

{
    "Response": {
        "AsyncRequestId": 129632,
        "RequestId": "77db16d7-bbe8-48a7-868b-ed776a96f1ab"
    }
}

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. 错误码

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

错误码	描述
AuthFailure	CAM签名/鉴权错误。
FailedOperation	操作失败。
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameterValue	参数取值错误。
LimitExceeded	超过配额限制。
MissingParameter	缺少参数错误。
OperationDenied	操作被拒绝。
OperationDenied.UserHasNoStrategy	CAM鉴权错误。
ResourceNotFound	资源不存在。
UnauthorizedOperation	未授权操作。
UnknownParameter	未知参数错误。
UnsupportedOperation	操作不支持。

创建健康报告生成任务

本页目录：