tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

GetRule

Last updated: 2023-12-01 16:50:01

    1. API Description

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

    This API is used to get the details of an event rule.

    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: GetRule.
    Version Yes String Common Params. The value used for this API: 2021-04-16.
    Region No String Common Params. This parameter is not required for this API.
    EventBusId Yes String Event bus ID
    RuleId Yes String Event rule ID

    3. Output Parameters

    Parameter Name Type Description
    EventBusId String Event bus ID
    RuleId String Event rule ID
    RuleName String Event rule name
    Status String Event rule status
    Enable Boolean Switch
    Description String Event rule description
    EventPattern String Event pattern
    AddTime Timestamp ISO8601 Creation time
    ModTime Timestamp ISO8601 Update time
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying details of a rule

    This example shows you how to query details of a rule.

    Input Example

    POST / HTTP/1.1
Host: eb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetRule
<Common request parameters>

{
    "EventBusId": "eb-l65vlc2",
    "RuleId": "rule-qr2wsqqy"
}

    Output Example

    {
    "Response": {
        "AddTime": "2021-04-29T20:01:27+08:00",
        "Description": "",
        "Enable": true,
        "EventBusId": "eb-l65vlc2u",
        "EventPattern": "{\"data\":{\"prefix\":[\"1\",\"2\"]}}",
        "ModTime": "2021-04-29T20:01:28+08:00",
        "RequestId": "9babdbaf-85d9-4d79-8eb7-14fd989cf99a",
        "RuleId": "rule-qr2wsqqy",
        "RuleName": "test",
        "Status": "Active"
    }
}

    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
    InternalError Internal error.
    InvalidParameterValue.EventBusId The EventBusId value does not conform to the specification. Please fix it and try again.
    InvalidParameterValue.RuleId The RuleId value does not conform to the specification. Please fix it and try again.
    ResourceNotFound The resource does not exist.
    ResourceNotFound.EventBus The specified event bus was not found. Please create it and try again.
    ResourceNotFound.Rule The specified Rule was not found. Please create it and try again.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy