tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
数据库智能管家 DBbrain
    文档
    Download PDF

    CreateDBDiagReportTask

    最后更新时间：2024-11-29 10:31:52
    下载PDF

      1. API Description

      Domain name for API request: dbbrain.intl.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.

      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 Params. The value used for this API: CreateDBDiagReportTask.
      Version Yes String Common Params. The value used for this API: 2021-05-27.
      Region Yes String Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-mumbai, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
      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 Array of the IDs of recipients to receive email.
      ContactGroup.N No Array of Integer Array of IDs of recipient groups to receive email.
      Product No String Service type. Valid values: mysql (TencentDB for MySQL), cynosdb (TDSQL-C for MySQL). Default value: mysql.

      3. Output Parameters

      Parameter Name Type Description
      AsyncRequestId Integer Async task request ID, which can be used to query the execution result of an async task.
      Note: This field may return null, indicating that no valid values can be obtained.
      RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

      4. Example

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

      Input Example

      https://dbbrain.intl.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
      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.
      联系我们

      联系我们，为您的业务提供专属服务。

      联系我们
      技术支持

      如果你想寻求进一步的帮助，通过工单与我们进行联络。我们提供7x24的工单服务。

      提交工单
      7x24 电话支持
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      隐私条款服务条款缓存条款