tencent cloud

1. API Description

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

This API is used to create a rule in the rule engine.

A maximum of 20 requests can be initiated per second for this API.

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.

3. Output Parameters

4. Example

Example1 CreateRule

This example shows you how to create a rule engine.

Input Example

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

{
    "Status": "disable",
    "Rules": [
        {
            "Actions": [
                {
                    "NormalAction": {
                        "Action": "RangeOriginPull",
                        "Parameters": [
                            {
                                "Name": "Switch",
                                "Values": [
                                    "on"
                                ]
                            }
                        ]
                    }
                },
                {
                    "CodeAction": {
                        "Action": "StatusCodeCache",
                        "Parameters": [
                            {
                                "Name": "CacheTime",
                                "StatusCode": 400,
                                "Values": [
                                    "20"
                                ]
                            }
                        ]
                    }
                },
                {
                    "RewriteAction": {
                        "Action": "ResponseHeader",
                        "Parameters": [
                            {
                                "Action": "set",
                                "Name": "Foo",
                                "Values": [
                                    "Bar"
                                ]
                            },
                            {
                                "Action": "add",
                                "Name": "Hello",
                                "Values": [
                                    "World"
                                ]
                            },
                            {
                                "Action": "del",
                                "Name": "Foo2",
                                "Values": []
                            }
                        ]
                    }
                }
            ],
            "Conditions": [
                {
                    "Conditions": [
                        {
                            "Operator": "equal",
                            "Target": "host",
                            "Values": [
                                "test.vernayang.com"
                            ]
                        }
                    ]
                }
            ]
        }
    ],
    "RuleName": "new_rule01",
    "ZoneId": "zone-qbjifysd"
}

Output Example

{
    "Response": {
        "RequestId": "811d2583-310c-41f4-b5e7-abe4074047d4",
        "RuleId": "rule-djuqmq"
    }
}

Example2 Changing the origin server type to IP domain name

This example shows you how to change the origin server type to IP domain name using the rule engine.

Input Example

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

{
    "ZoneId": "zone-2kmrcz5heaw2",
    "RuleName": "test_origin",
    "Status": "enable",
    "Rules": [
        {
            "Conditions": [
                {
                    "Conditions": [
                        {
                            "Operator": "equal",
                            "Target": "host",
                            "IgnoreCase": false,
                            "Values": [
                                "rule.test.cloud"
                            ]
                        },
                        {
                            "Operator": "equal",
                            "Target": "client_country",
                            "IgnoreCase": false,
                            "Values": [
                                "CN"
                            ]
                        }
                    ]
                }
            ],
            "Actions": [
                {
                    "NormalAction": {
                        "Action": "Origin",
                        "Parameters": [
                            {
                                "Name": "Type",
                                "Values": [
                                    "IP_DOMAIN"
                                ]
                            },
                            {
                                "Name": "DomainName",
                                "Values": [
                                    "1.1.1.1"
                                ]
                            },
                            {
                                "Name": "OriginProtocol",
                                "Values": [
                                    "follow"
                                ]
                            },
                            {
                                "Name": "HttpOriginPort",
                                "Values": [
                                    "80"
                                ]
                            },
                            {
                                "Name": "HttpsOriginPort",
                                "Values": [
                                    "443"
                                ]
                            }
                        ]
                    }
                }
            ],
            "SubRules": []
        }
    ]
}

Output Example

{
    "Response": {
        "RuleId": "rule-djuqsx",
        "RequestId": "811d2583-310c-41f4-b5e7-abe4074047d4"
    }
}

Example3 Changing the origin server type to origin server group

This example shows you how to change the origin server type to origin server group using the rule engine.

Input Example

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

{
    "ZoneId": "zone-2kmrcz5heaw2",
    "RuleName": "test_origin",
    "Status": "enable",
    "Rules": [
        {
            "Conditions": [
                {
                    "Conditions": [
                        {
                            "Operator": "equal",
                            "Target": "host",
                            "IgnoreCase": false,
                            "Values": [
                                "rule.test.cloud"
                            ]
                        },
                        {
                            "Operator": "equal",
                            "Target": "client_country",
                            "IgnoreCase": false,
                            "Values": [
                                "CN"
                            ]
                        }
                    ]
                }
            ],
            "Actions": [
                {
                    "NormalAction": {
                        "Action": "Origin",
                        "Parameters": [
                            {
                                "Name": "Type",
                                "Values": [
                                    "OriginGroup"
                                ]
                            },
                            {
                                "Name": "OriginGroupId",
                                "Values": [
                                    "origin-ff7e677b-2c4d-11ee-9687-525400521111"
                                ]
                            },
                            {
                                "Name": "OriginProtocol",
                                "Values": [
                                    "follow"
                                ]
                            },
                            {
                                "Name": "HttpOriginPort",
                                "Values": [
                                    "80"
                                ]
                            },
                            {
                                "Name": "HttpsOriginPort",
                                "Values": [
                                    "443"
                                ]
                            }
                        ]
                    }
                }
            ],
            "SubRules": []
        }
    ]
}

Output Example

{
    "Response": {
        "RuleId": "rule-djuq9s",
        "RequestId": "811d2583-310c-41f4-b5e7-abe407404sdsd"
    }
}

Example4 Changing the origin server type to load balancing

This example shows you how to change the origin server type to load balancing using the rule engine.

Input Example

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

{
    "ZoneId": "zone-2kmrcz5heaw2",
    "RuleName": "test_origin",
    "Status": "enable",
    "Rules": [
        {
            "Conditions": [
                {
                    "Conditions": [
                        {
                            "Operator": "equal",
                            "Target": "host",
                            "IgnoreCase": false,
                            "Values": [
                                "rule.test.cloud"
                            ]
                        },
                        {
                            "Operator": "equal",
                            "Target": "client_country",
                            "IgnoreCase": false,
                            "Values": [
                                "CN"
                            ]
                        }
                    ]
                }
            ],
            "Actions": [
                {
                    "NormalAction": {
                        "Action": "Origin",
                        "Parameters": [
                            {
                                "Name": "Type",
                                "Values": [
                                    "LoadBalance"
                                ]
                            },
                            {
                                "Name": "OriginGroupId",
                                "Values": [
                                    "lb-ff7e677b-2c4d-11ee-9687"
                                ]
                            },
                            {
                                "Name": "OriginProtocol",
                                "Values": [
                                    "follow"
                                ]
                            },
                            {
                                "Name": "HttpOriginPort",
                                "Values": [
                                    "80"
                                ]
                            },
                            {
                                "Name": "HttpsOriginPort",
                                "Values": [
                                    "443"
                                ]
                            }
                        ]
                    }
                }
            ],
            "SubRules": []
        }
    ]
}

Output Example

{
    "Response": {
        "RuleId": "rule-djuq91",
        "RequestId": "811d2583-310c-41f4-b5e7-abe407404xs"
    }
}

Example5 Changing the origin server type to S3-compatible object storage

This example shows you how to change the origin server type to S3-compatible object storage using the rule engine.

Input Example

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

{
    "ZoneId": "zone-2kmrcz5heaw2",
    "RuleName": "test_origin",
    "Status": "enable",
    "Rules": [
        {
            "Conditions": [
                {
                    "Conditions": [
                        {
                            "Operator": "equal",
                            "Target": "host",
                            "IgnoreCase": false,
                            "Values": [
                                "rule.test.cloud"
                            ]
                        },
                        {
                            "Operator": "equal",
                            "Target": "client_country",
                            "IgnoreCase": false,
                            "Values": [
                                "CN"
                            ]
                        }
                    ]
                }
            ],
            "Actions": [
                {
                    "NormalAction": {
                        "Action": "Origin",
                        "Parameters": [
                            {
                                "Name": "Type",
                                "Values": [
                                    "AWS_S3"
                                ]
                            },
                            {
                                "Name": "ServerName",
                                "Values": [
                                    "bucke_name.gcp.storage.com"
                                ]
                            },
                            {
                                "Name": "PrivateAccess",
                                "Values": [
                                    "on"
                                ]
                            },
                            {
                                "Name": "AccessKeyId",
                                "Values": [
                                    "xxxx******xxxx"
                                ]
                            },
                            {
                                "Name": "SecretAccessKey",
                                "Values": [
                                    "xxxx******xxxx"
                                ]
                            },
                            {
                                "Name": "SignatureVersion",
                                "Values": [
                                    "v4"
                                ]
                            },
                            {
                                "Name": "Region",
                                "Values": [
                                    "ap-guangzhou"
                                ]
                            }
                        ]
                    }
                }
            ],
            "SubRules": []
        }
    ]
}

Output Example

{
    "Response": {
        "RuleId": "rule-djuq23",
        "RequestId": "811d2583-310c-41f4-b5e7-abe407404sxsd"
    }
}

Example6 Changing the origin server type to COS

This example shows you how to change the origin server type to COS using the rule engine.

Input Example

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

{
    "ZoneId": "zone-2kmrcz5heaw2",
    "RuleName": "test_origin",
    "Status": "enable",
    "Rules": [
        {
            "Conditions": [
                {
                    "Conditions": [
                        {
                            "Operator": "equal",
                            "Target": "host",
                            "IgnoreCase": false,
                            "Values": [
                                "rule.test.cloud"
                            ]
                        },
                        {
                            "Operator": "equal",
                            "Target": "client_country",
                            "IgnoreCase": false,
                            "Values": [
                                "CN"
                            ]
                        }
                    ]
                }
            ],
            "Actions": [
                {
                    "NormalAction": {
                        "Action": "Origin",
                        "Parameters": [
                            {
                                "Name": "Type",
                                "Values": [
                                    "COS"
                                ]
                            },
                            {
                                "Name": "ServerName",
                                "Values": [
                                    "bucke_name.gcp.storage.com"
                                ]
                            },
                            {
                                "Name": "CosPrivateAccess",
                                "Values": [
                                    "on"
                                ]
                            }
                        ]
                    }
                }
            ],
            "SubRules": []
        }
    ]
}

Output Example

{
    "Response": {
        "RuleId": "rule-djuq21",
        "RequestId": "811d2583-310c-41f4-b5e7-abe407404hs"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

• Tencent Cloud SDK 3.0 for Python
• Tencent Cloud SDK 3.0 for Java
• Tencent Cloud SDK 3.0 for PHP
• Tencent Cloud SDK 3.0 for Go
• Tencent Cloud SDK 3.0 for Node.js
• Tencent Cloud SDK 3.0 for .NET
• Tencent Cloud SDK 3.0 for C++

Command Line Interface

• Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.