有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

接口请求域名: gaap.tencentcloudapi.com 。

本接口(ModifyRuleAttribute)用于修改转发规则的信息,包括健康检查的配置以及转发策略。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyRuleAttribute。
Version String 公共参数,本接口取值:2018-05-29。
Region String 公共参数,此参数为可选参数。
ListenerId String 监听器ID
示例值:listener-8fueuc9
RuleId String 转发规则ID
示例值:rule-5g8dh58
Scheduler String 监听器源站访问策略,其中:rr表示轮询;wrr表示加权轮询;lc表示最小连接数;lrtt表示最小时延。
示例值:rr
HealthCheck Integer 源站健康检查开关,其中:
1,开启;
0,关闭。
示例值:0
CheckParams RuleCheckParams 健康检查配置参数
Path String 转发规则路径
示例值:/
ForwardProtocol String 加速通道转发到源站的协议类型,支持:default, HTTP和HTTPS。
当ForwardProtocol=default时,表示使用对应监听器的ForwardProtocol。
示例值:default
ForwardHost String 回源Host。加速通道转发到源站的请求中携带的host。
当ForwardHost=default时,使用规则的域名,其他情况为该字段所设置的值。
ServerNameIndicationSwitch String 服务器名称指示(ServerNameIndication,简称SNI)开关。ON表示开启,OFF表示关闭。
示例值:OFF
ServerNameIndication String 服务器名称指示(ServerNameIndication,简称SNI),当SNI开关打开时,该字段必填。
示例值:www.qq.com
ForcedRedirect String HTTP强制跳转HTTPS。输入当前规则对应的域名与地址。
示例值:https://www.qq.com/url

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 修改转发规则信息

输入示例

POST / HTTP/1.1
Host: gaap.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyRuleAttribute
<公共请求参数>

{
    "RuleId": "rule-5g8dh58",
    "HealthCheck": "0",
    "ListenerId": "listener-8fueuc9",
    "CheckParams": {
        "Domain": "string",
        "ConnectTimeout": "12",
        "Path": "str",
        "Method": "string",
        "DelayLoop": "1",
        "StatusCode": [
            "1"
        ]
    },
    "Scheduler": "rr",
    "Path": "/"
}

输出示例

{
    "Response": {
        "RequestId": "c7bfcad5-3f20-472f-9afc-13a66faebad8"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
AuthFailure CAM签名/鉴权错误。
AuthFailure.NotEnterpriseAuthorization 非企业认证客户。
AuthFailure.UnauthorizedOperation 子账户未授权操作。
FailedOperation 操作失败。
FailedOperation.InstanceStatusNotInRuning 通道状态为非运行状态,无法操作。
FailedOperation.ListenerHasTask 监听器正在操作中,请勿重复操作。
FailedOperation.NonStandardProxy 该通道为非标通道,限制所有写操作。
FailedOperation.RuleAlreadyExisted 规则已经存在。
FailedOperation.UserNotConfirmProtocol 未开通协议。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
ResourceNotFound 资源不存在。
ResourceUnavailable.AccountViolation 账号下存在违规资源,详情请查看站内信或邮件。
UnauthorizedOperation 未授权操作。