Last updated: 2020-09-25 14:26:27

1. API Description

Domain name for API request:

This API is used to pull the list of rules based on rule ID. It supports pulling 1 to 10 rules at a time.

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 parameter. The value used for this API: DescribeRulesByRuleIds.
Version Yes String Common parameter. The value used for this API: 2018-05-29.
Region No String Common parameter. This parameter is not required for this API.
RuleIds.N Yes Array of String List of rule IDs. Up to 10 rules are supported.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer The number of returned rules.
RuleSet Array of RuleInfo List of returned rules.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Pulling the list of rules based on rule ID

Input Example
&<Common request parameter>

Output Example

  "Response": {
    "TotalCount": 1,
    "RequestId": "f0508c22-aba5-4eee-8365-a64018b1328f",
    "RuleSet": [
        "BindStatus": 1,
        "Domain": "",
        "RealServerType": "IP",
        "Scheduler": "rr",
        "RuleId": "rule-3bsuu01r",
        "HealthCheck": 0,
        "ListenerId": "listener-gwm92kvx",
        "CheckParams": {
          "Domain": "",
          "ConnectTimeout": 2,
          "Path": "/",
          "Method": "HEAD",
          "DelayLoop": 30,
          "StatusCode": [
        "ForwardHost": "default",
        "Path": "/",
        "RealServerSet": [],
        "RuleStatus": 0

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.


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
FailedOperation Operation failed.
FailedOperation.ResourceCanNotAccess This resource is not accessible.
InternalError Internal error.
InvalidParameter Incorrect parameter.
InvalidParameterValue Incorrect parameter value.
MissingParameter Missing parameter.
ResourceNotFound The resource does not exist.
ResourceUnavailable The resource is unavailable.
UnauthorizedOperation Unauthorized operation.
UnknownParameter Unknown parameter.
UnsupportedOperation This operation is not supported.