tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateSchedulerMailProfile

Last updated: 2023-10-17 10:51:57

    1. API Description

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

    This API is used to create the regular generation time of health reports and the regular email sending configuration. Pass in the regular generation time of health reports as a parameter (Monday to Sunday) to set the regular generation time, and save the corresponding regular email sending configuration.

    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: CreateSchedulerMailProfile.
    Version Yes String Common Params. The value used for this API: 2021-05-27.
    Region No String Common Params. This parameter is not required for this API.
    WeekConfiguration.N Yes Array of Integer Value range: 1-7, representing Monday to Sunday respectively.
    ProfileInfo Yes ProfileInfo Email configuration.
    ProfileName Yes String Configuration name, which needs to be unique. For scheduled task emails, the name should be in the format of "scheduler_" + {instanceId}, such as "schduler_cdb-test".
    BindInstanceId Yes String ID of the instance for which to configure subscription.
    Product Yes String Service type. Valid values: mysql (TencentDB for MySQL), cynosdb (TDSQL-C for MySQL). Default value: mysql.

    3. Output Parameters

    Parameter Name Type Description
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Creating the scheduled task email sending configuration

    This example shows you how to create the regular generation time of health reports and the regular email sending configuration. Pass in the regular generation time of health reports as a parameter (Monday to Sunday) to set the regular generation time, and save the corresponding regular email sending configuration.

    Input Example

    https://dbbrain.tencentcloudapi.com/?Action=CreateSchedulerMailProfile
&WeekConfiguration.0=1
&Product=mysql
&ProfileName=scheduler_cdb-test
&BindInstanceId=cdb-test
&ProfileInfo.Language=zh
&ProfileInfo.MailConfiguration.SendMail=1
&ProfileInfo.MailConfiguration.Region.0=ap-guangzhou
&ProfileInfo.MailConfiguration.HealthStatus.0=HEALTH
&ProfileInfo.MailConfiguration.ContactPerson.0=1
&ProfileInfo.MailConfiguration.ContactGroup.0=1
&<Common request parameters>

    Output Example

    {
    "Response": {
        "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.
    RequestLimitExceeded The number of requests exceeds the frequency limit.
    ResourceNotFound The resource does not exist.
    UnauthorizedOperation The operation is unauthorized.
    UnknownParameter Unknown parameter.
    UnsupportedOperation Unsupported operation.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy