tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateDBDiagReportTask

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

1. API Description

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

This API is used to create a health report and send it via email as configured.

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: CreateDBDiagReportTask.
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.
InstanceId Yes String Instance ID.
StartTime Yes Timestamp ISO8601 Start time, such as 2020-11-08T14:00:00+08:00.
EndTime Yes Timestamp ISO8601 End time, such as 2020-11-09T14:00:00+08:00.
SendMailFlag Yes Integer Whether to send an email. Valid values: 0 - Yes, 1 - No.
ContactPerson.N No Array of Integer An array of contact IDs to receive the email.
ContactGroup.N No Array of Integer An array of contact group IDs to receive the email.
Product No String Service type. Valid values: mysql (TencentDB for MySQL), cynosdb (TencentDB for CynosDB (compatible with MySQL)). Default value: mysql.

3. Output Parameters

Parameter Name Type Description
AsyncRequestId Integer ID of an async task request, which can be used to query the execution result of an async task.
Note: this field may return null, indicating that no valid value is obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating a health report and sending it via email (optional)

Input Example

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
&<common request parameters>

Output Example

{
  "Response": {
    "AsyncRequestId": 129632,
    "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

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
InvalidParameter Incorrect parameter.
MissingParameter Missing parameter.
OperationDenied.UserHasNoStrategy Error with CAM authentication.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy