{ "name": "gaap", "display_name": "全球应用加速", "description": "介绍如何使用API对全球应用加速操作，包括监听器、通道、源站等。", "domain": "network", "api_version": "2018-05-29", "endpoint": "gaap.tencentcloudapi.com", "actions": [ { "name": "AddRealServers", "description": "添加源站(服务器)信息，支持IP或域名", "status": "online", "parameters": [ { "name": "ProjectId", "type": "integer", "required": true, "description": "源站对应的项目ID", "example": "0" }, { "name": "RealServerIP", "type": "array", "required": true, "description": "源站对应的IP或域名", "example": "[\"1.1.1.1\\n\"]", "item_type": "string" }, { "name": "RealServerName", "type": "string", "required": true, "description": "源站名称", "example": "real_server_name" }, { "name": "TagSet", "type": "array", "required": false, "description": "标签列表", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "key" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签值", "example": "value" } ] } ], "required": [ "ProjectId", "RealServerIP", "RealServerName" ] }, { "name": "BanAndRecoverProxy", "description": "本接口（BanAndRecoverProxy）用于联通封禁解封GAAP跨境通道实例，支持按照客户UIN维度下发请求。被封禁的实例带宽上限将会被限制到0Mbps，无法正常处理客户端和源站之间的请求。", "status": "online", "parameters": [], "required": [] }, { "name": "BindListenerRealServers", "description": "本接口（BindListenerRealServers）用于TCP/UDP监听器绑定解绑源站。 注意：本接口会解绑之前绑定的源站，绑定本次调用所选择的源站。例如：原来绑定的源站为A，B，C，本次调用的选择绑定的源站为C，D，E，那么调用后所绑定的源站为C，D，E。", "status": "online", "parameters": [ { "name": "ListenerId", "type": "string", "required": true, "description": "监听器ID", "example": "listener-pbsgn7ej" }, { "name": "RealServerBindSet", "type": "array", "required": false, "description": "待绑定源站列表。如果该监听器的源站调度策略是加权轮询，需要填写源站权重 RealServerWeight, 不填或者其他调度类型默认源站权重为1。", "example": "无", "item_type": "object", "children": [ { "name": "RealServerId", "type": "string", "required": true, "description": "源站id", "example": "rs-123456" }, { "name": "RealServerPort", "type": "integer", "required": true, "description": "源站端口", "example": "443" }, { "name": "RealServerIP", "type": "string", "required": true, "description": "源站IP", "example": "192.168.1.1" }, { "name": "RealServerWeight", "type": "integer", "required": false, "description": "源站权重", "example": "1" }, { "name": "RealServerFailoverRole", "type": "string", "required": false, "description": "源站主备角色：master表示主，slave表示备，该参数必须在监听器打开了源站主备模式。", "example": "master" } ] } ], "required": [ "ListenerId" ] }, { "name": "BindRuleRealServers", "description": "该接口用于7层监听器的转发规则绑定源站。注意：本接口会解绑之前绑定的源站，绑定本次调用所选择的源站。", "status": "online", "parameters": [ { "name": "RuleId", "type": "string", "required": true, "description": "转发规则ID", "example": "0" }, { "name": "RealServerBindSet", "type": "array", "required": false, "description": "需要绑定的源站信息列表。 如果已经存在绑定的源站，则会覆盖更新成这个源站列表。 当不带该字段时，表示解绑该规则上的所有源站。 如果该规则的源站调度策略是加权轮询，需要填写源站权重 RealServerWeight, 不填或者其他调度类型默认源站权重为1。", "example": "无", "item_type": "object", "children": [ { "name": "RealServerId", "type": "string", "required": true, "description": "源站id", "example": "rs-123456" }, { "name": "RealServerPort", "type": "integer", "required": true, "description": "源站端口", "example": "443" }, { "name": "RealServerIP", "type": "string", "required": true, "description": "源站IP", "example": "192.168.1.1" }, { "name": "RealServerWeight", "type": "integer", "required": false, "description": "源站权重", "example": "1" }, { "name": "RealServerFailoverRole", "type": "string", "required": false, "description": "源站主备角色：master表示主，slave表示备，该参数必须在监听器打开了源站主备模式。", "example": "master" } ] } ], "required": [ "RuleId" ] }, { "name": "CheckProxyCreate", "description": "本接口(CheckProxyCreate)用于查询能否创建指定配置的加速通道。", "status": "online", "parameters": [ { "name": "AccessRegion", "type": "string", "required": true, "description": "通道的接入(加速)区域。取值可通过接口DescribeAccessRegionsByDestRegion获取到", "example": "EastChina" }, { "name": "RealServerRegion", "type": "string", "required": true, "description": "通道的源站区域。取值可通过接口DescribeDestRegions获取到", "example": "SouthChina" }, { "name": "Bandwidth", "type": "integer", "required": true, "description": "通道带宽上限，单位：Mbps。", "example": "10" }, { "name": "Concurrent", "type": "integer", "required": true, "description": "通道并发量上限，表示同时在线的连接数，单位：万。", "example": "2" }, { "name": "GroupId", "type": "string", "required": false, "description": "如果在通道组下创建通道，需要填写通道组的ID", "example": "lg-b4c3d2a1" }, { "name": "IPAddressVersion", "type": "string", "required": false, "description": "IP版本，可取值：IPv4、IPv6，默认值IPv4", "example": "IPv4" }, { "name": "NetworkType", "type": "string", "required": false, "description": "网络类型，可取值：normal、cn2，默认值normal", "example": "normal" }, { "name": "PackageType", "type": "string", "required": false, "description": "通道套餐类型。Thunder表示标准通道组，Accelerator表示游戏加速器通道，CrossBorder表示跨境通道。", "example": "Thunder" }, { "name": "Http3Supported", "type": "integer", "required": false, "description": "该字段已废弃，当IPAddressVersion为IPv4时，所创建的通道默认支持Http3.0；当为IPv6，默认不支持Http3.0。", "example": "0" } ], "required": [ "AccessRegion", "RealServerRegion", "Bandwidth", "Concurrent" ] }, { "name": "CloseProxies", "description": "本接口（CloseProxies）用于关闭通道。通道关闭后，不再产生流量，但每天仍然收取通道基础配置费用。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": false, "description": "（旧参数，请切换到ProxyIds）通道的实例ID。", "example": "[\"link-w34r23rf\"]", "item_type": "string" }, { "name": "ClientToken", "type": "string", "required": false, "description": "用于保证请求幂等性的字符串。该字符串由客户生成，需保证不同请求之间唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。 更多详细信息请参阅：如何保证幂等性。", "example": "qwe3e43242f424" }, { "name": "ProxyIds", "type": "array", "required": false, "description": "（新参数）通道的实例ID。", "example": "[\"link-11112222\\n\"]", "item_type": "string" } ], "required": [] }, { "name": "CloseProxyGroup", "description": "本接口（CloseProxyGroup）用于关闭通道组。通道组关闭后，不再产生流量，但每天仍然收取通道基础配置费用。", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "通道组的实例 ID。", "example": "lg-111xxxx" } ], "required": [ "GroupId" ] }, { "name": "CloseSecurityPolicy", "description": "关闭安全策略", "status": "online", "parameters": [ { "name": "ProxyId", "type": "string", "required": false, "description": "通道ID。操作通道组时无需填此参数。", "example": "link-xxxx" }, { "name": "PolicyId", "type": "string", "required": false, "description": "安全组策略ID。操作通道组时须填此参数。", "example": "policy-lwe3456l" } ], "required": [] }, { "name": "CreateCertificate", "description": "本接口（CreateCertificate）用于创建Gaap相关证书和配置文件，包括基础认证配置文件，客户端CA证书，服务器SSL证书，Gaap SSL证书以及源站CA证书。", "status": "online", "parameters": [ { "name": "CertificateType", "type": "integer", "required": true, "description": "证书类型。其中：0，表示基础认证配置；1，表示客户端CA证书；2，服务器SSL证书；3，表示源站CA证书；4，表示通道SSL证书。", "example": "2" }, { "name": "CertificateContent", "type": "string", "required": true, "description": "证书内容。采用url编码。其中：当证书类型为基础认证配置时，该参数填写用户名/密码对。格式：“用户名：密码”，例如：root:FSGdT。其中密码使用htpasswd或者openssl，例如：openssl passwd -crypt 123456。当证书类型为CA/SSL证书时，该参数填写证书内容，格式为pem。", "example": "%0A-----BEGIN%20CERTIFICATE-----%0AMIIFmDC.....ARmE%3D%0A-----END%20CERTIFICATE-----%0A" }, { "name": "CertificateAlias", "type": "string", "required": false, "description": "证书名称", "example": "cert-xl2hh434" }, { "name": "CertificateKey", "type": "string", "required": false, "description": "密钥内容。采用url编码。仅当证书类型为SSL证书时，需要填写该参数。格式为pem。", "example": "%0A-----BEGIN%20RSA%20PRIVATE%20KEY-----%0Axxxxxxxxxxx%0A-----END%20RSA%20PRIVATE%20KEY-----%0A" } ], "required": [ "CertificateType", "CertificateContent" ] }, { "name": "CreateCustomHeader", "description": "本接口（CreateCustomHeader）用于创建HTTP/HTTPS监听器的自定义header，客户端请求通过访问该监听器时，会将监听器中配置的header信息发送到源站。", "status": "online", "parameters": [ { "name": "RuleId", "type": "string", "required": true, "description": "规则id", "example": "rule-18vhg67" }, { "name": "Headers", "type": "array", "required": false, "description": "新增的header名称和内容列表， ‘’$remote_addr‘’会被解析替换成客户端ip，其他值原样透传到源站。", "example": "[{\"HeaderName\":\"X-REAL_IP\",\"HeaderValue\":\"$remote_addr\"}]", "item_type": "object", "children": [ { "name": "HeaderName", "type": "string", "required": true, "description": "HTTP头名", "example": "X-HTTP-TEST-HEADER" }, { "name": "HeaderValue", "type": "string", "required": true, "description": "HTTP头值", "example": "X-HTTP-TEST-VALUE" } ] } ], "required": [ "RuleId" ] }, { "name": "CreateDomain", "description": "本接口（CreateDomain）用于创建HTTP/HTTPS监听器的访问域名，客户端请求通过访问该域名来请求后端业务。 该接口仅支持version3.0的通道。", "status": "online", "parameters": [ { "name": "ListenerId", "type": "string", "required": true, "description": "监听器ID。", "example": "0" }, { "name": "Domain", "type": "string", "required": true, "description": "需要创建的域名，一个监听器下最大支持100个域名。", "example": "a.a.com" }, { "name": "CertificateId", "type": "string", "required": false, "description": "服务器证书，用于客户端与GAAP的HTTPS的交互。", "example": "cert-j3l3l4l5" }, { "name": "ClientCertificateId", "type": "string", "required": false, "description": "客户端CA证书，用于客户端与GAAP的HTTPS的交互。 仅当采用双向认证的方式时，需要设置该字段或PolyClientCertificateIds字段。", "example": "cert-j3l3l4l5" }, { "name": "PolyClientCertificateIds", "type": "array", "required": false, "description": "客户端CA证书，用于客户端与GAAP的HTTPS的交互。 仅当采用双向认证的方式时，需要设置该字段或ClientCertificateId字段。", "example": "[\"\"cert-j3l3l4l5\"]", "item_type": "string" }, { "name": "Http3Supported", "type": "integer", "required": false, "description": "是否开启Http3特性的标识，其中： 0，表示不开启Http3； 1，表示开启Http3。 默认不开启Http3。可以通过SetDomainHttp3开启。", "example": "0" }, { "name": "IsDefaultServer", "type": "boolean", "required": false, "description": "是否作为默认域名，默认为“否”", "example": "false" } ], "required": [ "ListenerId", "Domain" ] }, { "name": "CreateDomainErrorPageInfo", "description": "定制域名指定错误码的错误响应", "status": "online", "parameters": [ { "name": "ListenerId", "type": "string", "required": true, "description": "监听器ID", "example": "0" }, { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "a.com" }, { "name": "ErrorNos", "type": "array", "required": true, "description": "原始错误码", "example": "[501,502]", "item_type": "integer" }, { "name": "Body", "type": "string", "required": true, "description": "新的响应包体", "example": "helloword" }, { "name": "NewErrorNo", "type": "integer", "required": false, "description": "新错误码", "example": "400" }, { "name": "ClearHeaders", "type": "array", "required": false, "description": "需要删除的响应头", "example": "[\"Host\"]", "item_type": "string" }, { "name": "SetHeaders", "type": "array", "required": false, "description": "需要设置的响应头", "example": "无", "item_type": "object", "children": [ { "name": "HeaderName", "type": "string", "required": true, "description": "HTTP头名", "example": "X-HTTP-TEST-HEADER" }, { "name": "HeaderValue", "type": "string", "required": true, "description": "HTTP头值", "example": "X-HTTP-TEST-VALUE" } ] } ], "required": [ "ListenerId", "Domain", "ErrorNos", "Body" ] }, { "name": "CreateGlobalDomain", "description": "用来创建统一域名", "status": "online", "parameters": [ { "name": "ProjectId", "type": "integer", "required": true, "description": "域名所属项目ID", "example": "0" }, { "name": "DefaultValue", "type": "string", "required": true, "description": "域名默认入口", "example": "1.1.1.1" }, { "name": "Alias", "type": "string", "required": false, "description": "别名", "example": "domain_name" }, { "name": "TagSet", "type": "array", "required": false, "description": "标签列表", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "key" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签值", "example": "value" } ] } ], "required": [ "ProjectId", "DefaultValue" ] }, { "name": "CreateGlobalDomainDns", "description": "创建域名解析记录", "status": "online", "parameters": [ { "name": "DomainId", "type": "string", "required": true, "description": "域名ID", "example": "dm-00ye8ek7" }, { "name": "ProxyIdList", "type": "array", "required": true, "description": "通道ID列表", "example": "[\"111\\n\"]", "item_type": "string" }, { "name": "NationCountryInnerCodes", "type": "array", "required": true, "description": "国家ID列表", "example": "[\"221\\n\"]", "item_type": "string" } ], "required": [ "DomainId", "ProxyIdList", "NationCountryInnerCodes" ] }, { "name": "CreateHTTPListener", "description": "该接口（CreateHTTPListener）用于在通道实例下创建HTTP协议类型的监听器。", "status": "online", "parameters": [ { "name": "ListenerName", "type": "string", "required": true, "description": "监听器名称", "example": "listener-1" }, { "name": "Port", "type": "integer", "required": true, "description": "监听器端口，基于同种传输层协议（TCP 或 UDP）的监听器，端口不可重复", "example": "443" }, { "name": "ProxyId", "type": "string", "required": false, "description": "通道ID，与GroupId不能同时设置，对应为通道创建监听器", "example": "link-cuxw2rm0" }, { "name": "GroupId", "type": "string", "required": false, "description": "通道组ID，与ProxyId不能同时设置，对应为通道组创建监听器", "example": "lg-123456" } ], "required": [ "ListenerName", "Port" ] }, { "name": "CreateHTTPSListener", "description": "该接口（CreateHTTPSListener）用于在通道实例下创建HTTPS协议类型的监听器。", "status": "online", "parameters": [ { "name": "ListenerName", "type": "string", "required": true, "description": "监听器名称", "example": "listener-1" }, { "name": "Port", "type": "integer", "required": true, "description": "监听器端口，基于同种传输层协议（TCP 或 UDP）的监听器，端口不可重复", "example": "443" }, { "name": "CertificateId", "type": "string", "required": true, "description": "服务器证书ID", "example": "N4Al2mhF" }, { "name": "ForwardProtocol", "type": "string", "required": true, "description": "加速通道转发到源站的协议类型：HTTP | HTTPS", "example": "HTTP" }, { "name": "ProxyId", "type": "string", "required": false, "description": "通道ID，与GroupId之间只能设置一个。表示创建通道的监听器。", "example": "link-cuxw2rm0" }, { "name": "AuthType", "type": "integer", "required": false, "description": "认证类型，其中：0，单向认证；1，双向认证。默认使用单向认证。", "example": "0" }, { "name": "ClientCertificateId", "type": "string", "required": false, "description": "客户端CA单证书ID，仅当双向认证时设置该参数或PolyClientCertificateIds参数", "example": "cert-12345" }, { "name": "PolyClientCertificateIds", "type": "array", "required": false, "description": "新的客户端多CA证书ID，仅当双向认证时设置该参数或设置ClientCertificateId参数", "example": "[\"cert-123456\"]", "item_type": "string" }, { "name": "GroupId", "type": "string", "required": false, "description": "通道组ID，与ProxyId之间只能设置一个。表示创建通道组的监听器。", "example": "lg-12345" }, { "name": "Http3Supported", "type": "integer", "required": false, "description": "支持Http3的开关，其中：0，表示不需要支持Http3接入；1，表示需要支持Http3接入。注意：如果支持了Http3的功能，那么该监听器会占用对应的UDP接入端口，不可再创建相同端口的UDP监听器。该功能的启停无法在监听器创建完毕后再修改。", "example": "0" } ], "required": [ "ListenerName", "Port", "CertificateId", "ForwardProtocol" ] }, { "name": "CreateProxy", "description": "本接口（CreateProxy）用于创建/复制一个指定配置的加速通道。当复制通道时，需要设置新通道的基本配置参数，并设置ClonedProxyId来指定被复制的通道。", "status": "online", "parameters": [ { "name": "ProjectId", "type": "integer", "required": true, "description": "通道的项目ID。", "example": "0" }, { "name": "ProxyName", "type": "string", "required": true, "description": "通道名称。", "example": "proxy_name" }, { "name": "AccessRegion", "type": "string", "required": true, "description": "接入地域。", "example": "GuangZhou" }, { "name": "Bandwidth", "type": "integer", "required": true, "description": "通道带宽上限，单位：Mbps。", "example": "10" }, { "name": "Concurrent", "type": "integer", "required": true, "description": "通道并发量上限，表示同时在线的连接数，单位：万。", "example": "2" }, { "name": "RealServerRegion", "type": "string", "required": false, "description": "源站地域。当GroupId存在时，源站地域为通道组的源站地域,此时可不填该字段。当GroupId不存在时，需要填写该字段", "example": "Hongkong" }, { "name": "ClientToken", "type": "string", "required": false, "description": "用于保证请求幂等性的字符串。该字符串由客户生成，需保证不同请求之间唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。 更多详细信息请参阅：如何保证幂等性。", "example": "\"SFGRETH235FDSFG534SFDDS\"" }, { "name": "GroupId", "type": "string", "required": false, "description": "通道所在的通道组ID，当在通道组中创建通道时必带，否则忽略该字段。", "example": "lg-2sczm0nv" }, { "name": "TagSet", "type": "array", "required": false, "description": "通道需要添加的标签列表。", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "key" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签值", "example": "value" } ] }, { "name": "ClonedProxyId", "type": "string", "required": false, "description": "被复制的通道ID。只有处于运行中状态的通道可以被复制。 当设置该参数时，表示复制该通道。", "example": "link-nphqtout" }, { "name": "BillingType", "type": "integer", "required": false, "description": "计费方式 (0:按带宽计费，1:按流量计费 默认按带宽计费）", "example": "0" }, { "name": "IPAddressVersion", "type": "string", "required": false, "description": "IP版本，可取值：IPv4、IPv6，默认值IPv4", "example": "IPv4" }, { "name": "NetworkType", "type": "string", "required": false, "description": "网络类型，normal表示常规BGP，cn2表示精品BGP，triple表示三网", "example": "normal" }, { "name": "PackageType", "type": "string", "required": false, "description": "通道套餐类型，Thunder表示标准通道组，Accelerator表示游戏加速器通道，CrossBorder表示跨境通道。", "example": "Thunder" }, { "name": "Http3Supported", "type": "integer", "required": false, "description": "该字段已废弃，当IPAddressVersion为IPv4时，所创建的通道默认支持Http3.0；当为IPv6，默认不支持Http3.0。", "example": "0" } ], "required": [ "ProjectId", "ProxyName", "AccessRegion", "Bandwidth", "Concurrent" ] }, { "name": "CreateProxyGroup", "description": "本接口（CreateProxyGroup）用于创建通道组。", "status": "online", "parameters": [ { "name": "ProjectId", "type": "integer", "required": true, "description": "通道组所属项目ID", "example": "1000" }, { "name": "GroupName", "type": "string", "required": true, "description": "通道组别名", "example": "group_name" }, { "name": "RealServerRegion", "type": "string", "required": true, "description": "源站地域，参考接口 [https://cloud.tencent.com/document/api/608/36964] 返回参数RegionDetail中的RegionId", "example": "EastChina" }, { "name": "TagSet", "type": "array", "required": false, "description": "标签列表", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "key" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签值", "example": "value" } ] }, { "name": "AccessRegionSet", "type": "array", "required": false, "description": "加速地域列表，包括加速地域名，及该地域对应的带宽和并发配置。", "example": "无", "item_type": "object", "children": [ { "name": "AccessRegion", "type": "string", "required": true, "description": "加速地域。", "example": "EastChina" }, { "name": "Bandwidth", "type": "integer", "required": true, "description": "通道带宽上限，单位：Mbps。", "example": "10" }, { "name": "Concurrent", "type": "integer", "required": true, "description": "通道并发量上限，表示同时在线的连接数，单位：万。", "example": "2" }, { "name": "NetworkType", "type": "string", "required": false, "description": "网络类型，可取值：normal、cn2，默认值为normal", "example": "normal" } ] }, { "name": "IPAddressVersion", "type": "string", "required": false, "description": "IP版本，可取值：IPv4、IPv6，默认值IPv4", "example": "IPV4" }, { "name": "PackageType", "type": "string", "required": false, "description": "通道组套餐类型，可取值：Thunder、Accelerator，默认值Thunder", "example": "Thunder" }, { "name": "Http3Supported", "type": "integer", "required": false, "description": "该字段已废弃，当IPAddressVersion为IPv4时，所创建的通道组默认支持Http3.0；当为IPv6，默认不支持Http3.0。", "example": "0" } ], "required": [ "ProjectId", "GroupName", "RealServerRegion" ] }, { "name": "CreateProxyGroupDomain", "description": "本接口（CreateProxyGroupDomain）用于创建通道组域名，并开启域名解析。", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "需要开启域名的通道组ID。", "example": "lg-b7h4d02f" } ], "required": [ "GroupId" ] }, { "name": "CreateRule", "description": "该接口（CreateRule）用于创建HTTP/HTTPS监听器转发规则。", "status": "online", "parameters": [ { "name": "ListenerId", "type": "string", "required": true, "description": "7层监听器ID", "example": "listener-9jt0rtv9" }, { "name": "Domain", "type": "string", "required": true, "description": "转发规则的域名", "example": "www.bbb.com" }, { "name": "Path", "type": "string", "required": true, "description": "转发规则的路径", "example": "%2Fimage" }, { "name": "RealServerType", "type": "string", "required": true, "description": "转发规则对应源站的类型，支持IP和DOMAIN类型。", "example": "IP" }, { "name": "Scheduler", "type": "string", "required": true, "description": "监听器源站访问策略，其中：rr表示轮询；wrr表示加权轮询；lc表示最小连接数。", "example": "rr" }, { "name": "HealthCheck", "type": "integer", "required": true, "description": "规则是否开启健康检查，1开启，0关闭。", "example": "1" }, { "name": "CheckParams", "type": "object", "required": false, "description": "源站健康检查相关参数", "example": "无", "children": [ { "name": "DelayLoop", "type": "integer", "required": true, "description": "健康检查的时间间隔", "example": "30" }, { "name": "ConnectTimeout", "type": "integer", "required": true, "description": "健康检查的响应超时时间", "example": "2" }, { "name": "Path", "type": "string", "required": true, "description": "健康检查的检查路径", "example": "\"/\"" }, { "name": "Method", "type": "string", "required": true, "description": "健康检查的方法，GET/HEAD", "example": "\"HEAD\"" }, { "name": "StatusCode", "type": "array", "required": true, "description": "确认源站正常的返回码，可选范围[100, 200, 300, 400, 500]", "example": "[100, 200, 300, 400, 500]", "item_type": "integer" }, { "name": "Domain", "type": "string", "required": false, "description": "健康检查的检查域名。 当调用ModifyRuleAttribute时，不支持修改该参数。", "example": "\"www.qq.com\"" }, { "name": "FailedCountInter", "type": "integer", "required": false, "description": "源站服务失败统计频率", "example": "60" }, { "name": "FailedThreshold", "type": "integer", "required": false, "description": "源站健康性检查阀值，超过该阀值会屏蔽服务", "example": "5" }, { "name": "BlockInter", "type": "integer", "required": false, "description": "源站健康性检测超出阀值后，屏蔽的时间", "example": "600" } ] }, { "name": "ForwardProtocol", "type": "string", "required": false, "description": "加速通道转发到源站的协议类型：支持HTTP或HTTPS。不传递该字段时表示使用对应监听器的ForwardProtocol。", "example": "HTTP" }, { "name": "ForwardHost", "type": "string", "required": false, "description": "回源Host。加速通道转发到源站的host，不设置该参数时，使用默认的host设置，即客户端发起的http请求的host。", "example": "www.baidu.com" }, { "name": "ServerNameIndicationSwitch", "type": "string", "required": false, "description": "服务器名称指示（ServerNameIndication，简称SNI）开关。ON表示开启，OFF表示关闭。创建HTTP监听器转发规则时，SNI功能默认关闭。", "example": "OFF" }, { "name": "ServerNameIndication", "type": "string", "required": false, "description": "服务器名称指示（ServerNameIndication，简称SNI），当SNI开关打开时，该字段必填。", "example": "www.qq.com" }, { "name": "ForcedRedirect", "type": "string", "required": false, "description": "HTTP强制跳转HTTPS。输入当前规则对应的域名与地址。", "example": "https://www.qq.com/url" } ], "required": [ "ListenerId", "Domain", "Path", "RealServerType", "Scheduler", "HealthCheck" ] }, { "name": "CreateSecurityPolicy", "description": "创建安全策略", "status": "online", "parameters": [ { "name": "DefaultAction", "type": "string", "required": true, "description": "默认策略：ACCEPT或DROP", "example": "Accept" }, { "name": "ProxyId", "type": "string", "required": false, "description": "加速通道ID", "example": "link-1234" }, { "name": "GroupId", "type": "string", "required": false, "description": "通道组ID", "example": "lg-123456" } ], "required": [ "DefaultAction" ] }, { "name": "CreateSecurityRules", "description": "添加安全策略规则", "status": "online", "parameters": [ { "name": "PolicyId", "type": "string", "required": true, "description": "安全策略ID", "example": "字符串" }, { "name": "RuleList", "type": "array", "required": true, "description": "访问规则列表", "example": "无", "item_type": "object", "children": [ { "name": "SourceCidr", "type": "string", "required": true, "description": "请求来源IP或IP段。", "example": "113.16.26.77" }, { "name": "Action", "type": "string", "required": true, "description": "策略：允许（ACCEPT）或拒绝（DROP）", "example": "DROP" }, { "name": "AliasName", "type": "string", "required": false, "description": "规则别名", "example": "policy_name" }, { "name": "Protocol", "type": "string", "required": false, "description": "协议：TCP或UDP，ALL表示所有协议", "example": "TCP" }, { "name": "DestPortRange", "type": "string", "required": false, "description": "目标端口，填写格式举例： 单个端口: 80 多个端口: 80,443 连续端口: 3306-20000 所有端口: ALL", "example": "9300" } ] } ], "required": [ "PolicyId", "RuleList" ] }, { "name": "CreateTCPListeners", "description": "该接口（CreateTCPListeners）用于批量创建单通道或者通道组的TCP协议类型的监听器。", "status": "online", "parameters": [ { "name": "ListenerName", "type": "string", "required": true, "description": "监听器名称。", "example": "test1" }, { "name": "Ports", "type": "array", "required": true, "description": "监听器端口列表。", "example": "[\"90\\n\"]", "item_type": "integer" }, { "name": "Scheduler", "type": "string", "required": true, "description": "监听器源站访问策略，其中：rr表示轮询；wrr表示加权轮询；lc表示最小连接数；lrtt表示最小时延。", "example": "rr" }, { "name": "HealthCheck", "type": "integer", "required": true, "description": "源站是否开启健康检查：1开启，0关闭，UDP监听器不支持健康检查", "example": "1" }, { "name": "RealServerType", "type": "string", "required": true, "description": "监听器绑定源站类型。IP表示IP地址，DOMAIN表示域名。", "example": "IP" }, { "name": "ProxyId", "type": "string", "required": false, "description": "通道ID，ProxyId和GroupId必须设置一个，但不能同时设置。", "example": "link-bjkpdum1" }, { "name": "GroupId", "type": "string", "required": false, "description": "通道组ID，ProxyId和GroupId必须设置一个，但不能同时设置。", "example": "lg-bjkpdum1" }, { "name": "DelayLoop", "type": "integer", "required": false, "description": "源站健康检查时间间隔，单位：秒。时间间隔取值在[5，300]之间。", "example": "20" }, { "name": "ConnectTimeout", "type": "integer", "required": false, "description": "源站健康检查响应超时时间，单位：秒。超时时间取值在[2，60]之间。超时时间应小于健康检查时间间隔DelayLoop。", "example": "20" }, { "name": "RealServerPorts", "type": "array", "required": false, "description": "源站端口列表，该参数仅支持v1版本监听器和通道组监听器。", "example": "[443]", "item_type": "integer" }, { "name": "ClientIPMethod", "type": "integer", "required": false, "description": "监听器获取客户端 IP 的方式，0表示 TOA, 1表示Proxy Protocol", "example": "0" }, { "name": "FailoverSwitch", "type": "integer", "required": false, "description": "源站是否开启主备模式：1开启，0关闭，DOMAIN类型源站不支持开启", "example": "0" }, { "name": "HealthyThreshold", "type": "integer", "required": false, "description": "健康阈值，表示连续检查成功多少次后认定源站健康。范围为1到10", "example": "5" }, { "name": "UnhealthyThreshold", "type": "integer", "required": false, "description": "不健康阈值，表示连续检查失败多少次数后认为源站不健康。范围为1到10", "example": "1" } ], "required": [ "ListenerName", "Ports", "Scheduler", "HealthCheck", "RealServerType" ] }, { "name": "CreateUDPListeners", "description": "该接口（CreateUDPListeners）用于批量创建单通道或者通道组的UDP协议类型的监听器。", "status": "online", "parameters": [ { "name": "ListenerName", "type": "string", "required": true, "description": "监听器名称", "example": "test1" }, { "name": "Ports", "type": "array", "required": true, "description": "监听器端口列表", "example": "[\"90\\n\"]", "item_type": "integer" }, { "name": "Scheduler", "type": "string", "required": true, "description": "监听器源站访问策略，其中：rr表示轮询；wrr表示加权轮询；lc表示最小连接数；lrtt表示最小时延。", "example": "rr" }, { "name": "RealServerType", "type": "string", "required": true, "description": "监听器绑定源站类型。IP表示IP地址，DOMAIN表示域名。", "example": "IP" }, { "name": "ProxyId", "type": "string", "required": false, "description": "通道ID，ProxyId和GroupId必须设置一个，但不能同时设置。", "example": "link-bjkpdum1" }, { "name": "GroupId", "type": "string", "required": false, "description": "通道组ID，ProxyId和GroupId必须设置一个，但不能同时设置。", "example": "lg-xxxx" }, { "name": "RealServerPorts", "type": "array", "required": false, "description": "源站端口列表，该参数仅支持v1版本监听器和通道组监听器", "example": "[80]", "item_type": "integer" }, { "name": "DelayLoop", "type": "integer", "required": false, "description": "源站健康检查时间间隔，单位：秒。时间间隔取值在[5，300]之间。", "example": "20" }, { "name": "ConnectTimeout", "type": "integer", "required": false, "description": "源站健康检查响应超时时间，单位：秒。超时时间取值在[2，60]之间。超时时间应小于健康检查时间间隔DelayLoop。", "example": "20" }, { "name": "HealthyThreshold", "type": "integer", "required": false, "description": "健康阈值，表示连续检查成功多少次后认定源站健康。范围为1到10", "example": "5" }, { "name": "UnhealthyThreshold", "type": "integer", "required": false, "description": "不健康阈值，表示连续检查失败多少次数后认为源站不健康。范围为1到10", "example": "1" }, { "name": "FailoverSwitch", "type": "integer", "required": false, "description": "源站是否开启主备模式：1开启，0关闭，DOMAIN类型源站不支持开启", "example": "0" }, { "name": "HealthCheck", "type": "integer", "required": false, "description": "源站是否开启健康检查：1开启，0关闭。", "example": "1" }, { "name": "CheckType", "type": "string", "required": false, "description": "UDP源站健康类型。PORT表示检查端口，PING表示PING。", "example": "PING" }, { "name": "CheckPort", "type": "integer", "required": false, "description": "UDP源站健康检查探测端口。", "example": "8888" }, { "name": "ContextType", "type": "string", "required": false, "description": "UDP源站健康检查端口探测报文类型：TEXT表示文本。仅在健康检查类型为PORT时使用。", "example": "TEXT" }, { "name": "SendContext", "type": "string", "required": false, "description": "UDP源站健康检查端口探测发送报文。仅在健康检查类型为PORT时使用。", "example": "helloworld" }, { "name": "RecvContext", "type": "string", "required": false, "description": "UDP源站健康检查端口探测接收报文。仅在健康检查类型为PORT时使用。", "example": "helloworld" } ], "required": [ "ListenerName", "Ports", "Scheduler", "RealServerType" ] }, { "name": "DeleteCertificate", "description": "本接口（DeleteCertificate）用于删除证书。", "status": "online", "parameters": [ { "name": "CertificateId", "type": "string", "required": true, "description": "需要删除的证书ID。", "example": "cert-afdsf2345" } ], "required": [ "CertificateId" ] }, { "name": "DeleteDomain", "description": "本接口（DeleteDomain）仅适用于7层监听器，用于删除该监听器下对应域名及域名下的所有规则，所有已绑定源站的规则将自动解绑。", "status": "online", "parameters": [ { "name": "ListenerId", "type": "string", "required": true, "description": "监听器ID", "example": "0" }, { "name": "Domain", "type": "string", "required": true, "description": "需要删除的域名", "example": "a.a.com" }, { "name": "Force", "type": "integer", "required": true, "description": "是否强制删除已绑定源站的转发规则，0非强制，1强制。 当采用非强制删除时，如果域名下已有规则绑定了源站，则无法删除。", "example": "1" } ], "required": [ "ListenerId", "Domain", "Force" ] }, { "name": "DeleteDomainErrorPageInfo", "description": "删除域名的定制错误", "status": "online", "parameters": [ { "name": "ErrorPageId", "type": "string", "required": true, "description": "定制错误响应页的唯一ID，请参考CreateDomainErrorPageInfo的响应", "example": "errorPage-xxxx" } ], "required": [ "ErrorPageId" ] }, { "name": "DeleteGlobalDomain", "description": "删除统一域名", "status": "online", "parameters": [ { "name": "DomainId", "type": "string", "required": true, "description": "域名ID", "example": "test.com" } ], "required": [ "DomainId" ] }, { "name": "DeleteGlobalDomainDns", "description": "删除域名的某条解析记录", "status": "online", "parameters": [ { "name": "DnsRecordId", "type": "integer", "required": true, "description": "解析记录的ID", "example": "223" } ], "required": [ "DnsRecordId" ] }, { "name": "DeleteListeners", "description": "该接口（DeleteListeners）用于批量删除通道或通道组的监听器，包括4/7层监听器。", "status": "online", "parameters": [ { "name": "ListenerIds", "type": "array", "required": true, "description": "待删除的监听器ID列表", "example": "[\"listener-o0f3at99\\n\"]", "item_type": "string" }, { "name": "Force", "type": "integer", "required": true, "description": "已绑定源站的监听器是否允许强制删除，1：允许， 0：不允许", "example": "1" }, { "name": "GroupId", "type": "string", "required": false, "description": "通道组ID，该参数和ProxyId必须设置一个，但不能同时设置。", "example": "lg-04tnkmt9" }, { "name": "ProxyId", "type": "string", "required": false, "description": "通道ID，该参数和GroupId必须设置一个，但不能同时设置。", "example": "link-3d85gh" } ], "required": [ "ListenerIds", "Force" ] }, { "name": "DeleteProxyGroup", "description": "本接口（DeleteProxyGroup）用于删除通道组。", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "需要删除的通道组ID。", "example": "lg-b7h4d02f" }, { "name": "Force", "type": "integer", "required": false, "description": "强制删除标识。其中： 0，不强制删除， 1，强制删除。 默认为0，当通道组中存在通道或通道组中存在监听器/规则绑定了源站时，且Force为0时，该操作会返回失败。", "example": "0" } ], "required": [ "GroupId" ] }, { "name": "DeleteRule", "description": "该接口（DeleteRule）用于删除HTTP/HTTPS监听器的转发规则。", "status": "online", "parameters": [ { "name": "ListenerId", "type": "string", "required": true, "description": "7层监听器ID", "example": "0" }, { "name": "RuleId", "type": "string", "required": true, "description": "转发规则ID", "example": "rule-18vhg67" }, { "name": "Force", "type": "integer", "required": true, "description": "是否可以强制删除已绑定源站的转发规则，0非强制，1强制", "example": "1" } ], "required": [ "ListenerId", "RuleId", "Force" ] }, { "name": "DeleteSecurityPolicy", "description": "删除安全策略", "status": "online", "parameters": [ { "name": "PolicyId", "type": "string", "required": true, "description": "策略ID", "example": "sp-hw5czrxx" } ], "required": [ "PolicyId" ] }, { "name": "DeleteSecurityRules", "description": "删除安全策略规则", "status": "online", "parameters": [ { "name": "PolicyId", "type": "string", "required": true, "description": "安全策略ID", "example": "sp-xxxx" }, { "name": "RuleIdList", "type": "array", "required": true, "description": "访问规则ID列表", "example": "[\"sr-xxx\\n\"]", "item_type": "string" } ], "required": [ "PolicyId", "RuleIdList" ] }, { "name": "DescribeAccessRegions", "description": "本接口（DescribeAccessRegions）用于查询加速区域，即客户端接入区域。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeAccessRegionsByDestRegion", "description": "本接口（DescribeAccessRegionsByDestRegion）根据源站区域查询可用的加速区域列表。", "status": "online", "parameters": [ { "name": "DestRegion", "type": "string", "required": true, "description": "源站区域：接口DescribeDestRegions返回DestRegionSet中的RegionId字段值", "example": "SouthChina" }, { "name": "IPAddressVersion", "type": "string", "required": false, "description": "IP版本，可取值：IPv4、IPv6，默认值IPv4", "example": "IPv4" }, { "name": "PackageType", "type": "string", "required": false, "description": "通道套餐类型，Thunder表示标准通道组，Accelerator表示游戏加速器通道，CrossBorder表示跨境通道。", "example": "Thunder" } ], "required": [ "DestRegion" ] }, { "name": "DescribeAuthSignature", "description": "为了防止在下单、询价、后付费开通等过程中确保来源合法以及订单参数没有被篡改过，各个业务方使用下单、询价等场景需调用计费签名接口获取签名，获取签名的请求需带上签名以验证身份，本接口可以获取计费签名。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeBlackHeader", "description": "本接口（DescribeBlackHeader）用于查询禁用的自定义header 名称", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeCertificateDetail", "description": "本接口（DescribeCertificateDetail）用于查询证书详情，包括证书ID，证书名字，证书类型，证书内容以及密钥等信息。", "status": "online", "parameters": [ { "name": "CertificateId", "type": "string", "required": true, "description": "证书ID。", "example": "cert-d5y6ei3b" } ], "required": [ "CertificateId" ] }, { "name": "DescribeCertificates", "description": "本接口（DescribeCertificates）用来查询可以使用的证书列表。", "status": "online", "parameters": [ { "name": "CertificateType", "type": "integer", "required": false, "description": "证书类型。其中： 0，表示基础认证配置； 1，表示客户端CA证书； 2，表示服务器SSL证书； 3，表示源站CA证书； 4，表示通道SSL证书。 -1，所有类型。 默认为-1。", "example": "2" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "限制数量，默认为20。", "example": "1" } ], "required": [] }, { "name": "DescribeCountryAreaMapping", "description": "本接口（DescribeCountryAreaMapping）用于获取国家地区编码映射表。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeCrossBorderProxies", "description": "本接口（DescribeCrossBorderProxies）用于查询跨境通道实例列表。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeCustomHeader", "description": "本接口（DescribeCustomHeader）用于自定义header列表", "status": "online", "parameters": [ { "name": "RuleId", "type": "string", "required": true, "description": "规则ID", "example": "rule-18vhg67" } ], "required": [ "RuleId" ] }, { "name": "DescribeDestRegions", "description": "本接口（DescribeDestRegions）用于查询源站区域，即源站服务器所在区域。", "status": "online", "parameters": [ { "name": "QualityType", "type": "integer", "required": false, "description": "通道质量:0表示金牌，1表示银牌。默认不传该参数，表示金牌。本参数确定查询指定通道质量的源站区域", "example": "1" } ], "required": [] }, { "name": "DescribeDomainErrorPageInfo", "description": "查询指定域名的错误响应", "status": "online", "parameters": [ { "name": "ListenerId", "type": "string", "required": true, "description": "监听器ID", "example": "0" }, { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "a.com" } ], "required": [ "ListenerId", "Domain" ] }, { "name": "DescribeDomainErrorPageInfoByIds", "description": "根据定制错误ID查询错误响应", "status": "online", "parameters": [ { "name": "ErrorPageIds", "type": "array", "required": true, "description": "定制错误ID列表，最多支持10个", "example": "[\"errorPage-lhlnux1v\\n\"]", "item_type": "string" } ], "required": [ "ErrorPageIds" ] }, { "name": "DescribeGlobalDomainDns", "description": "查询域名解析列表", "status": "online", "parameters": [ { "name": "DomainId", "type": "string", "required": true, "description": "域名ID", "example": "test.com" } ], "required": [ "DomainId" ] }, { "name": "DescribeGlobalDomains", "description": "查询域名列表", "status": "online", "parameters": [ { "name": "ProjectId", "type": "integer", "required": true, "description": "项目ID", "example": "0" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "分页数量限制", "example": "112" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤条件", "example": "name" }, { "name": "Values", "type": "array", "required": true, "description": "过滤值", "example": "value", "item_type": "string" } ] }, { "name": "TagSet", "type": "array", "required": false, "description": "标签列表，当存在该字段时，拉取对应标签下的资源列表。 最多支持5个标签，当存在两个或两个以上的标签时，满足其中任意一个标签时，域名会被拉取出来。", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "key" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签值", "example": "value" } ] } ], "required": [ "ProjectId", "Offset", "Limit" ] }, { "name": "DescribeGroupAndStatisticsProxy", "description": "该接口为内部接口，用于查询可以获取统计数据的通道组和通道信息", "status": "online", "parameters": [ { "name": "ProjectId", "type": "integer", "required": true, "description": "项目ID", "example": "0" } ], "required": [ "ProjectId" ] }, { "name": "DescribeGroupDomainConfig", "description": "本接口（DescribeGroupDomainConfig）用于获取通道组域名解析配置详情。", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "通道组ID。", "example": "lg-b7h4d02f" } ], "required": [ "GroupId" ] }, { "name": "DescribeHTTPListeners", "description": "该接口（DescribeHTTPListeners）用来查询HTTP监听器信息。", "status": "online", "parameters": [ { "name": "ProxyId", "type": "string", "required": false, "description": "通道ID。ListenerId、ProxyId、GroupId须至少填写一个，且ProxyId与GroupId至多只能填写其中一个。", "example": "link-n9ha8jzl" }, { "name": "GroupId", "type": "string", "required": false, "description": "通道组ID。ListenerId、ProxyId、GroupId须至少填写一个，且ProxyId与GroupId至多只能填写其中一个。", "example": "lg-sadadd" }, { "name": "ListenerId", "type": "string", "required": false, "description": "过滤条件，按照监听器ID进行精确查询。ListenerId、ProxyId、GroupId须至少填写一个，且ProxyId与GroupId至多只能填写其中一个。", "example": "listerner-sfafdaf" }, { "name": "ListenerName", "type": "string", "required": false, "description": "过滤条件，按照监听器名称进行精确查询", "example": "listener_name" }, { "name": "Port", "type": "integer", "required": false, "description": "过滤条件，按照监听器端口进行精确查询", "example": "80" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "限制数量，默认为20个", "example": "20" }, { "name": "SearchValue", "type": "string", "required": false, "description": "过滤条件，支持按照端口或监听器名称进行模糊查询，该参数不能与ListenerName和Port同时使用", "example": "80" } ], "required": [] }, { "name": "DescribeHTTPSListeners", "description": "本接口（DescribeHTTPSListeners）用来查询HTTPS监听器信息。", "status": "online", "parameters": [ { "name": "ProxyId", "type": "string", "required": false, "description": "通道ID。ListenerId、ProxyId、GroupId须至少填写一个，且ProxyId与GroupId至多只能填写其中一个。", "example": "link-n9ha8jzl" }, { "name": "GroupId", "type": "string", "required": false, "description": "通道组ID。ListenerId、ProxyId、GroupId须至少填写一个，且ProxyId与GroupId至多只能填写其中一个。", "example": "lg-12345" }, { "name": "ListenerId", "type": "string", "required": false, "description": "过滤条件，根据监听器ID进行精确查询。ListenerId、ProxyId、GroupId须至少填写一个，且ProxyId与GroupId至多只能填写其中一个。", "example": "listener-12345" }, { "name": "ListenerName", "type": "string", "required": false, "description": "过滤条件，根据监听器名称进行精确查询。", "example": "listener-name" }, { "name": "Port", "type": "integer", "required": false, "description": "过滤条件，根据监听器端口进行精确查询。", "example": "80" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量， 默认为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "限制数量，默认为20", "example": "20" }, { "name": "SearchValue", "type": "string", "required": false, "description": "过滤条件，支持按照端口或监听器名称进行模糊查询", "example": "listener-search-name" }, { "name": "Http3Supported", "type": "integer", "required": false, "description": "支持Http3的开关，其中： 0，表示不需要支持Http3接入； 1，表示需要支持Http3接入。 注意：如果支持了Http3的功能，那么该监听器会占用对应的UDP接入端口，不可再创建相同端口的UDP监听器。 该功能的启停无法在监听器创建完毕后再修改。", "example": "0" } ], "required": [] }, { "name": "DescribeListenerRealServers", "description": "该接口（DescribeListenerRealServers）用于查询TCP/UDP监听器源站列表，包括该监听器已经绑定的源站列表以及可以绑定的源站列表。", "status": "online", "parameters": [ { "name": "ListenerId", "type": "string", "required": true, "description": "监听器ID", "example": "listener-pbsgn7ej" } ], "required": [ "ListenerId" ] }, { "name": "DescribeListenerStatistics", "description": "该接口用于查询监听器统计数据，包括出入带宽，出入包量，并发数据。支持300秒, 3600秒和86400秒的细粒度，取值为细粒度范围内最大值。", "status": "online", "parameters": [ { "name": "ListenerId", "type": "string", "required": true, "description": "监听器ID", "example": "listener-rfgt56hy" }, { "name": "StartTime", "type": "string", "required": true, "description": "起始时间", "example": "2019-03-25 12:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间", "example": "2019-03-26 12:00:00" }, { "name": "MetricNames", "type": "array", "required": true, "description": "统计指标名称列表，支持: 入带宽:InBandwidth, 出带宽:OutBandwidth, 并发:Concurrent, 入包量:InPackets, 出包量:OutPackets。", "example": "[\"InputBandwidth\\n\",\"OutputBandwidth\\n\"]", "item_type": "string" }, { "name": "Granularity", "type": "integer", "required": true, "description": "监控粒度，目前支持300，3600，86400，单位：秒。 查询时间范围不超过1天，支持最小粒度300秒； 查询间范围不超过7天，支持最小粒度3600秒； 查询间范围超过7天，支持最小粒度86400秒。", "example": "300" } ], "required": [ "ListenerId", "StartTime", "EndTime", "MetricNames", "Granularity" ] }, { "name": "DescribeProxies", "description": "本接口（DescribeProxies）用于查询通道实例列表。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": false, "description": "（旧参数，请切换到ProxyIds）按照一个或者多个实例ID查询。每次请求的实例的上限为100。参数不支持同时指定InstanceIds和Filters。", "example": "[\"proxy-123456\"]", "item_type": "string" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "1" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 每次请求的Filters的上限为10，Filter.Values的上限为5。参数不支持同时指定InstanceIds和Filters。 ProjectId - String - 是否必填：否 -（过滤条件）按照项目ID过滤。 AccessRegion - String - 是否必填：否 - （过滤条件）按照接入地域过滤。 RealServerRegion - String - 是否必填：否 - （过滤条件）按照源站地域过滤。GroupId - String - 是否必填：否 - （过滤条件）按照通道组ID过滤。IPAddressVer...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤条件", "example": "name" }, { "name": "Values", "type": "array", "required": true, "description": "过滤值", "example": "value", "item_type": "string" } ] }, { "name": "ProxyIds", "type": "array", "required": false, "description": "（新参数，替代InstanceIds）按照一个或者多个实例ID查询。每次请求的实例的上限为100。参数不支持同时指定InstanceIds和Filters。", "example": "[\"proxy-123456\"]", "item_type": "string" }, { "name": "TagSet", "type": "array", "required": false, "description": "标签列表，当存在该字段时，拉取对应标签下的资源列表。最多支持5个标签，当存在两个或两个以上的标签时，满足其中任意一个标签时，通道会被拉取出来。", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "key" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签值", "example": "value" } ] }, { "name": "Independent", "type": "integer", "required": false, "description": "当该字段为1时，仅拉取非通道组的通道，当该字段为0时，仅拉取通道组的通道，不存在该字段时，拉取所有通道，包括独立通道和通道组通道。", "example": "1" }, { "name": "Order", "type": "string", "required": false, "description": "输出通道列表的排列顺序。取值范围：asc：升序排列；desc：降序排列。默认为降序。", "example": "desc" }, { "name": "OrderField", "type": "string", "required": false, "description": "通道列表排序的依据字段。取值范围：create_time：依据通道的创建时间排序；proxy_id：依据通道的ID排序；bandwidth：依据通道带宽上限排序；concurrent_connections：依据通道并发排序；默认按通道创建时间排序。", "example": "create_time" } ], "required": [] }, { "name": "DescribeProxiesStatus", "description": "本接口（DescribeProxiesStatus）用于查询通道状态列表。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": false, "description": "（旧参数，请切换到ProxyIds）通道ID列表。", "example": "link-1234abcd", "item_type": "string" }, { "name": "ProxyIds", "type": "array", "required": false, "description": "（新参数）通道ID列表。", "example": "[\"link-1234abcd\"]", "item_type": "string" } ], "required": [] }, { "name": "DescribeProxyAndStatisticsListeners", "description": "该接口为内部接口，用于查询可以获取统计数据的通道和监听器信息", "status": "online", "parameters": [ { "name": "ProjectId", "type": "integer", "required": true, "description": "项目ID", "example": "0" } ], "required": [ "ProjectId" ] }, { "name": "DescribeProxyDetail", "description": "本接口（DescribeProxyDetail）用于查询通道详情。", "status": "online", "parameters": [ { "name": "ProxyId", "type": "string", "required": true, "description": "需查询的通道ID。", "example": "link-12345678" } ], "required": [ "ProxyId" ] }, { "name": "DescribeProxyGroupDetails", "description": "本接口（DescribeProxyGroupDetails）用于查询通道组详情。", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "通道组ID。", "example": "lg-123456" } ], "required": [ "GroupId" ] }, { "name": "DescribeProxyGroupList", "description": "本接口（DescribeProxyGroupList）用于拉取通道组列表及各通道组基本信息。", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": true, "description": "偏移量，默认值为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "返回数量，默认值为20，最大值为100。", "example": "20" }, { "name": "ProjectId", "type": "integer", "required": true, "description": "项目ID。取值范围：-1，该用户下所有项目0，默认项目其他值，指定的项目", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 每次请求的Filter.Values的上限为5。RealServerRegion - String - 是否必填：否 -（过滤条件）按照源站地域过滤，可参考DescribeDestRegions接口返回结果中的RegionId。PackageType - String - 是否必填：否 - （过滤条件）通道组类型，Thunder表示标准通道组，Accelerator表示银牌加速通道组。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤条件", "example": "name" }, { "name": "Values", "type": "array", "required": true, "description": "过滤值", "example": "value", "item_type": "string" } ] }, { "name": "TagSet", "type": "array", "required": false, "description": "标签列表，当存在该字段时，拉取对应标签下的资源列表。最多支持5个标签，当存在两个或两个以上的标签时，满足其中任意一个标签时，该通道组会被拉取出来。", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "key" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签值", "example": "value" } ] } ], "required": [ "Offset", "Limit", "ProjectId" ] }, { "name": "DescribeProxyGroupStatistics", "description": "该接口用于查询监听器统计数据，包括出入带宽，出入包量，并发数据。支持300, 3600和86400的细粒度，取值为细粒度范围内最大值。", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "通道组ID", "example": "lg-rfgt56hy" }, { "name": "StartTime", "type": "string", "required": true, "description": "起始时间", "example": "2019-03-25 12:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间", "example": "2019-03-26 12:00:00" }, { "name": "MetricNames", "type": "array", "required": true, "description": "统计指标名称列表，支持: 入带宽:InBandwidth, 出带宽:OutBandwidth, 并发:Concurrent, 入包量:InPackets, 出包量:OutPackets", "example": "[\"InputBandwidth\\n\"]", "item_type": "string" }, { "name": "Granularity", "type": "integer", "required": true, "description": "监控粒度，目前支持60，300，3600，86400，单位：秒。当时间范围不超过1天，支持最小粒度60秒；当时间范围不超过7天，支持最小粒度3600秒；当时间范围不超过30天，支持最小粒度86400秒。", "example": "300" } ], "required": [ "GroupId", "StartTime", "EndTime", "MetricNames", "Granularity" ] }, { "name": "DescribeProxyStatistics", "description": "该接口用于查询监听器统计数据，包括出入带宽，出入包量，并发，丢包和时延数据。支持300, 3600和86400的细粒度，取值为细粒度范围内最大值。", "status": "online", "parameters": [ { "name": "ProxyId", "type": "string", "required": true, "description": "通道ID", "example": "link-rfgt56hy" }, { "name": "StartTime", "type": "string", "required": true, "description": "起始时间(2019-03-25 12:00:00)", "example": "2019-03-25 12:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间(2019-03-25 12:00:00)", "example": "2019-03-26 12:00:00" }, { "name": "MetricNames", "type": "array", "required": true, "description": "统计指标名称列表，支持: 入带宽:InBandwidth, 出带宽:OutBandwidth, 并发:Concurrent, 入包量:InPackets, 出包量:OutPackets, 丢包率:PacketLoss, 延迟:Latency， HTTP请求量：HttpQPS, HTTP请求量利用率：HttpQPSPercent, HTTPS请求量：HttpsQPS, HTTPS请求量利用率：HttpsQPSPercent", "example": "[\"Concurrent\\n\"]", "item_type": "string" }, { "name": "Granularity", "type": "integer", "required": true, "description": "监控粒度，目前支持60，300，3600，86400，单位：秒。 当时间范围不超过3天，支持最小粒度60秒； 当时间范围不超过7天，支持最小粒度300秒； 当时间范围不超过30天，支持最小粒度3600秒。", "example": "300" }, { "name": "Isp", "type": "string", "required": false, "description": "运营商（通道为三网通道时有效），支持CMCC，CUCC，CTCC，传空值或不传则合并三个运营商数据", "example": "CMCC" } ], "required": [ "ProxyId", "StartTime", "EndTime", "MetricNames", "Granularity" ] }, { "name": "DescribeRealServerStatistics", "description": "该接口（DescribeRealServerStatistics）用于查询源站健康检查结果的统计数据。源站状态展示位为1：正常或者0：异常。查询的源站需要在监听器或者规则上进行了绑定，查询时需指定绑定的监听器或者规则ID。该接口支持1分钟细粒度的源站状态统计数据展示。", "status": "online", "parameters": [ { "name": "RealServerId", "type": "string", "required": true, "description": "源站ID", "example": "rs-rfgt56hy" }, { "name": "ListenerId", "type": "string", "required": false, "description": "监听器ID", "example": "listener-gucvb6d" }, { "name": "RuleId", "type": "string", "required": false, "description": "L7层规则ID", "example": "rule-jlfw45jl" }, { "name": "WithinTime", "type": "integer", "required": false, "description": "统计时长，单位：小时。仅支持最近1,3,6,12,24小时的统计查询", "example": "3" }, { "name": "StartTime", "type": "string", "required": false, "description": "统计开始时间(2020-08-19 00:00:00)", "example": "2020-08-19 00:00:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "统计结束时间(2020-08-19 23:59:59)", "example": "2020-08-19 23:59:59" }, { "name": "Granularity", "type": "integer", "required": false, "description": "统计的数据粒度，单位：秒，仅支持1分钟-60和5分钟-300粒度", "example": "60" } ], "required": [ "RealServerId" ] }, { "name": "DescribeRealServers", "description": "本接口（DescribeRealServers）用于查询源站信息，可以根据项目名查询所有的源站信息，此外支持指定IP或者域名的源站模糊查询。", "status": "online", "parameters": [ { "name": "ProjectId", "type": "integer", "required": true, "description": "查询源站的所属项目ID，-1表示所有项目", "example": "0" }, { "name": "SearchValue", "type": "string", "required": false, "description": "需要查询的源站IP或域名，支持模糊匹配", "example": "1.1.1.1" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认值是0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20个，最大值为50个", "example": "20" }, { "name": "TagSet", "type": "array", "required": false, "description": "标签列表，当存在该字段时，拉取对应标签下的资源列表。 最多支持5个标签，当存在两个或两个以上的标签时，满足其中任意一个标签时，源站会被拉取出来。", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "key" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签值", "example": "value" } ] }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。filter的name取值(RealServerName,RealServerIP)", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤条件", "example": "name" }, { "name": "Values", "type": "array", "required": true, "description": "过滤值", "example": "value", "item_type": "string" } ] } ], "required": [ "ProjectId" ] }, { "name": "DescribeRealServersStatus", "description": "本接口（DescribeRealServersStatus）用于查询源站是否已被规则或者监听器绑定", "status": "online", "parameters": [ { "name": "RealServerIds", "type": "array", "required": true, "description": "源站ID列表", "example": "[\"rs-4ftghy6\"]", "item_type": "string" } ], "required": [ "RealServerIds" ] }, { "name": "DescribeRegionAndPrice", "description": "该接口（DescribeRegionAndPrice）用于获取源站区域和带宽梯度价格", "status": "online", "parameters": [ { "name": "IPAddressVersion", "type": "string", "required": false, "description": "IP版本，可取值：IPv4、IPv6，默认值IPv4", "example": "IPv4" }, { "name": "PackageType", "type": "string", "required": false, "description": "通道套餐类型，Thunder表示标准通道组，Accelerator表示游戏加速器通道，CrossBorder表示跨境通道。", "example": "Thunder" } ], "required": [] }, { "name": "DescribeResourcesByTag", "description": "本接口（DescribeResourcesByTag）用于根据标签来查询对应的资源信息，包括通道，通道组和源站。", "status": "online", "parameters": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键。", "example": "tag_key" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签值。", "example": "tag_value" }, { "name": "ResourceType", "type": "string", "required": false, "description": "资源类型，其中： Proxy表示通道； ProxyGroup表示通道组； RealServer表示源站。 不指定该字段则查询该标签下所有资源。", "example": "Proxy" } ], "required": [ "TagKey", "TagValue" ] }, { "name": "DescribeRuleRealServers", "description": "本接口（DescribeRuleRealServers）用于查询转发规则相关的源站信息， 包括该规则可绑定的源站信息和已绑定的源站信息。", "status": "online", "parameters": [ { "name": "RuleId", "type": "string", "required": true, "description": "转发规则ID", "example": "rule-hh5xg2yd" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为1000。", "example": "20" } ], "required": [ "RuleId" ] }, { "name": "DescribeRules", "description": "本接口（DescribeRules）用于查询监听器下的所有规则信息，包括规则域名，路径以及该规则下所绑定的源站列表。当通道版本为3.0时，该接口会返回该域名对应的高级认证配置信息。", "status": "online", "parameters": [ { "name": "ListenerId", "type": "string", "required": true, "description": "7层监听器Id。", "example": "listener-9jt0rtv9" } ], "required": [ "ListenerId" ] }, { "name": "DescribeRulesByRuleIds", "description": "本接口（DescribeRulesByRuleIds）用于根据规则ID拉取规则信息列表。支持一个或者多个规则信息的拉取。一次最多支持10个规则信息的拉取。", "status": "online", "parameters": [ { "name": "RuleIds", "type": "array", "required": true, "description": "规则ID列表。最多支持10个规则。", "example": "[\"rule-3bsuu01r\"]", "item_type": "string" } ], "required": [ "RuleIds" ] }, { "name": "DescribeSecurityPolicyDetail", "description": "获取安全策略详情", "status": "online", "parameters": [ { "name": "PolicyId", "type": "string", "required": true, "description": "安全策略ID", "example": "sp-xxxx" } ], "required": [ "PolicyId" ] }, { "name": "DescribeSecurityRules", "description": "本接口（DescribeSecurityRules）用于根据安全规则ID查询安全规则详情列表。支持一个或多个安全规则的查询。一次最多支持20个安全规则的查询。", "status": "online", "parameters": [ { "name": "SecurityRuleIds", "type": "array", "required": true, "description": "安全规则ID列表。总数不能超过20个。", "example": "[\"sr-xxxxxxxx\\n\"]", "item_type": "string" } ], "required": [ "SecurityRuleIds" ] }, { "name": "DescribeTCPListeners", "description": "该接口（DescribeTCPListeners）用于查询单通道或者通道组下的TCP监听器信息。", "status": "online", "parameters": [ { "name": "ProxyId", "type": "string", "required": false, "description": "过滤条件，根据通道ID进行拉取，ProxyId/GroupId/ListenerId必须设置一个，但ProxyId和GroupId不能同时设置。", "example": "link-hwera8lq" }, { "name": "ListenerId", "type": "string", "required": false, "description": "过滤条件，根据监听器ID精确查询。 当设置了ProxyId时，会检查该监听器是否归属于该通道。 当设置了GroupId时，会检查该监听器是否归属于该通道组。", "example": "listener-gkzl9e7t" }, { "name": "ListenerName", "type": "string", "required": false, "description": "过滤条件，根据监听器名称精确查询", "example": "listener_name" }, { "name": "Port", "type": "integer", "required": false, "description": "过滤条件，根据监听器端口精确查询", "example": "443" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "限制数量，默认为20", "example": "20" }, { "name": "GroupId", "type": "string", "required": false, "description": "过滤条件，根据通道组ID进行拉取，ProxyId/GroupId/ListenerId必须设置一个，但ProxyId和GroupId不能同时设置。", "example": "lg-bjkpdum1" }, { "name": "SearchValue", "type": "string", "required": false, "description": "过滤条件，支持按照端口或监听器名称进行模糊查询，该参数不能与ListenerName和Port同时使用", "example": "link-bjkpdum1" } ], "required": [] }, { "name": "DescribeTaskStatus", "description": "查询异步任务执行状态", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": false, "description": "任务ID，值为异步接口返回的RequestId，此参数不能传空值。", "example": "hjl-23432-hflkdsjafklj" } ], "required": [] }, { "name": "DescribeUDPListeners", "description": "该接口（DescribeUDPListeners）用于查询单通道或者通道组下的UDP监听器信息", "status": "online", "parameters": [ { "name": "ProxyId", "type": "string", "required": false, "description": "过滤条件，根据通道ID进行拉取，ProxyId/GroupId/ListenerId必须设置一个，但ProxyId和GroupId不能同时设置。", "example": "link-hwera8lq" }, { "name": "ListenerId", "type": "string", "required": false, "description": "过滤条件，根据监听器ID精确查询。 当设置了ProxyId时，会检查该监听器是否归属于该通道。 当设置了GroupId时，会检查该监听器是否归属于该通道组。", "example": "listener-pbsgn7ej" }, { "name": "ListenerName", "type": "string", "required": false, "description": "过滤条件，根据监听器名称精确查询", "example": "test_listener" }, { "name": "Port", "type": "integer", "required": false, "description": "过滤条件，根据监听器端口精确查询", "example": "80" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "限制数量，默认为20", "example": "20" }, { "name": "GroupId", "type": "string", "required": false, "description": "过滤条件，根据通道组ID进行拉取，ProxyId/GroupId/ListenerId必须设置一个，但ProxyId和GroupId不能同时设置。", "example": "lg-sdfafadf" }, { "name": "SearchValue", "type": "string", "required": false, "description": "过滤条件，支持按照端口或监听器名称进行模糊查询，该参数不能与ListenerName和Port同时使用", "example": "80" } ], "required": [] }, { "name": "DestroyProxies", "description": "本接口（DestroyProxies）用于销毁。通道销毁后，不再产生任何费用。", "status": "online", "parameters": [ { "name": "Force", "type": "integer", "required": true, "description": "强制删除标识。 1，强制删除该通道列表，无论是否已经绑定了源站； 0，如果已绑定了源站，则无法删除。 删除多通道时，如果该标识为0，只有所有的通道都没有绑定源站，才允许删除。", "example": "1" }, { "name": "InstanceIds", "type": "array", "required": false, "description": "（旧参数，请切换到ProxyIds）通道实例ID列表。", "example": "[\"link-34524rerf\"]", "item_type": "string" }, { "name": "ClientToken", "type": "string", "required": false, "description": "用于保证请求幂等性的字符串。该字符串由客户生成，需保证不同请求之间唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。 更多详细信息请参阅：如何保证幂等性。", "example": "aeew3eq34r324f" }, { "name": "ProxyIds", "type": "array", "required": false, "description": "（新参数）通道实例ID列表。", "example": "[\"link-11112222\",\"link-11113333\"]", "item_type": "string" } ], "required": [ "Force" ] }, { "name": "DisableGlobalDomain", "description": "暂停域名解析", "status": "online", "parameters": [ { "name": "DomainId", "type": "string", "required": true, "description": "域名ID", "example": "dm-00ye8ek7" } ], "required": [ "DomainId" ] }, { "name": "EnableGlobalDomain", "description": "开启域名解析", "status": "online", "parameters": [ { "name": "DomainId", "type": "string", "required": true, "description": "域名ID", "example": "test.com" } ], "required": [ "DomainId" ] }, { "name": "InquiryPriceCreateProxy", "description": "本接口（InquiryPriceCreateProxy）用于创建加速通道询价。", "status": "online", "parameters": [ { "name": "AccessRegion", "type": "string", "required": true, "description": "加速区域名称。", "example": "EastChina" }, { "name": "Bandwidth", "type": "integer", "required": true, "description": "通道带宽上限，单位：Mbps。", "example": "10" }, { "name": "DestRegion", "type": "string", "required": false, "description": "（旧参数，请切换到RealServerRegion）源站区域名称。", "example": "GuangZhou" }, { "name": "Concurrency", "type": "integer", "required": false, "description": "（此参数为旧参数，请填写新参数Concurrent，二者必须填写一个）通道并发量上限，表示同时在线的连接数，单位：万。", "example": "2" }, { "name": "RealServerRegion", "type": "string", "required": false, "description": "（新参数）源站区域名称。", "example": "SouthChina" }, { "name": "Concurrent", "type": "integer", "required": false, "description": "（新参数）通道并发量上限，表示同时在线的连接数，单位：万。", "example": "10" }, { "name": "BillingType", "type": "integer", "required": false, "description": "计费方式，0表示按带宽计费，1表示按流量计费。默认按带宽计费", "example": "0" }, { "name": "IPAddressVersion", "type": "string", "required": false, "description": "IP版本，可取值：IPv4、IPv6，默认值IPv4", "example": "IPv4" }, { "name": "NetworkType", "type": "string", "required": false, "description": "网络类型，可取值：normal、cn2，默认值normal", "example": "normal" }, { "name": "PackageType", "type": "string", "required": false, "description": "通道套餐类型，Thunder表示标准通道组，Accelerator表示游戏加速器通道，CrossBorder表示跨境通道。", "example": "Thunder" }, { "name": "Http3Supported", "type": "integer", "required": false, "description": "该字段已废弃，当IPAddressVersion为IPv4时，所创建的通道默认支持Http3.0；当为IPv6，默认不支持Http3.0。", "example": "0" } ], "required": [ "AccessRegion", "Bandwidth" ] }, { "name": "ModifyCertificate", "description": "本接口（ModifyCertificate）用于修改监听器下的域名对应的证书。该接口仅适用于version3.0的通道。", "status": "online", "parameters": [ { "name": "ListenerId", "type": "string", "required": true, "description": "监听器实例ID", "example": "listener-xxx" }, { "name": "Domain", "type": "string", "required": true, "description": "需要修改证书的域名", "example": "www.test.com" }, { "name": "CertificateId", "type": "string", "required": true, "description": "新的服务器证书ID。其中： 当CertificateId=default时，表示使用监听器的证书。", "example": "cert-12345678" }, { "name": "ClientCertificateId", "type": "string", "required": false, "description": "新的客户端证书ID。其中： 当ClientCertificateId=default时，表示使用监听器的证书。 仅当采用双向认证方式时，需要设置该参数或者PolyClientCertificateIds。", "example": "cert-abcdefgh" }, { "name": "PolyClientCertificateIds", "type": "array", "required": false, "description": "新的多客户端证书ID列表。其中： 仅当采用双向认证方式时，需要设置该参数或ClientCertificateId参数。", "example": "[\"cert-abcdefgh\"]", "item_type": "string" } ], "required": [ "ListenerId", "Domain", "CertificateId" ] }, { "name": "ModifyCertificateAttributes", "description": "本接口（ModifyCertificateAttributes）用于修改证书，包括证书名字以及证书内容。", "status": "online", "parameters": [ { "name": "CertificateId", "type": "string", "required": true, "description": "证书ID。", "example": "cert-kj5pa5lj" }, { "name": "CertificateAlias", "type": "string", "required": false, "description": "证书名字。长度不超过50个字符。", "example": "cert-name" } ], "required": [ "CertificateId" ] }, { "name": "ModifyDomain", "description": "本接口（ModifyDomain）用于监听器下的域名。当通道版本为3.0时，支持对该域名所对应的证书修改。", "status": "online", "parameters": [ { "name": "ListenerId", "type": "string", "required": true, "description": "7层监听器ID", "example": "0" }, { "name": "OldDomain", "type": "string", "required": true, "description": "修改前的域名信息", "example": "a.a.com" }, { "name": "NewDomain", "type": "string", "required": true, "description": "修改后的域名信息", "example": "b.b.com" }, { "name": "CertificateId", "type": "string", "required": false, "description": "服务器SSL证书ID，仅适用于version3.0的通道。其中： 不带该字段时，表示使用原证书； 携带该字段时并且CertificateId=default，表示使用监听器证书； 其他情况，使用该CertificateId指定的证书。", "example": "default" }, { "name": "ClientCertificateId", "type": "string", "required": false, "description": "客户端CA证书ID，仅适用于version3.0的通道。其中： 不带该字段和PolyClientCertificateIds时，表示使用原证书； 携带该字段时并且ClientCertificateId=default，表示使用监听器证书； 其他情况，使用该ClientCertificateId或PolyClientCertificateIds指定的证书。", "example": "cert-ljfdslajjl" }, { "name": "PolyClientCertificateIds", "type": "array", "required": false, "description": "客户端CA证书ID，仅适用于version3.0的通道。其中： 不带该字段和ClientCertificateId时，表示使用原证书； 携带该字段时并且ClientCertificateId=default，表示使用监听器证书； 其他情况，使用该ClientCertificateId或PolyClientCertificateIds指定的证书。", "example": "[\"cert-ljfdslajjl\"]", "item_type": "string" }, { "name": "IsDefaultServer", "type": "boolean", "required": false, "description": "是否作为默认域名，默认为“否”", "example": "false" } ], "required": [ "ListenerId", "OldDomain", "NewDomain" ] }, { "name": "ModifyGlobalDomainAttribute", "description": "修改域名属性", "status": "online", "parameters": [ { "name": "DomainId", "type": "string", "required": true, "description": "域名ID", "example": "dm-00ye8ek7" }, { "name": "ProjectId", "type": "integer", "required": true, "description": "项目ID", "example": "0" }, { "name": "Alias", "type": "string", "required": false, "description": "别名", "example": "domain-name" }, { "name": "DefaultValue", "type": "string", "required": false, "description": "默认入口", "example": "1.1.1.1" } ], "required": [ "DomainId", "ProjectId" ] }, { "name": "ModifyGlobalDomainDns", "description": "修改域名解析记录", "status": "online", "parameters": [ { "name": "DnsRecordId", "type": "integer", "required": true, "description": "解析记录ID", "example": "3223" }, { "name": "DomainId", "type": "string", "required": true, "description": "域名ID", "example": "\"dm-00ye8ek7\"" }, { "name": "NationCountryInnerCodes", "type": "array", "required": true, "description": "国家ID列表", "example": "[\"100000\"]", "item_type": "string" }, { "name": "ProxyIdList", "type": "array", "required": true, "description": "通道ID列表", "example": "[\"link-wefarwqx\"]", "item_type": "string" } ], "required": [ "DnsRecordId", "DomainId", "NationCountryInnerCodes", "ProxyIdList" ] }, { "name": "ModifyGroupDomainConfig", "description": "本接口（ModifyGroupDomainConfig）用于配置通道组就近接入域名。", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "通道组ID。", "example": "lg-b7h4d02f" }, { "name": "DefaultDnsIp", "type": "string", "required": true, "description": "域名解析默认访问IP或域名。", "example": "1.1.1.1" }, { "name": "AccessRegionList", "type": "array", "required": false, "description": "就近接入区域配置。", "example": "无", "item_type": "object", "children": [ { "name": "RegionId", "type": "string", "required": true, "description": "地域ID。", "example": "ap-guangzhou" }, { "name": "NationCountryInnerList", "type": "array", "required": false, "description": "就近接入区域国家内部编码，编码列表可通过DescribeCountryAreaMapping接口获取。", "example": "[\"101001\", \"101002\"]", "item_type": "string" } ] } ], "required": [ "GroupId", "DefaultDnsIp" ] }, { "name": "ModifyHTTPListenerAttribute", "description": "该接口（ModifyHTTPListenerAttribute）用于修改通道的HTTP监听器配置信息，目前仅支持修改监听器的名称。 注意：通道组通道暂时不支持HTTP/HTTPS监听器。", "status": "online", "parameters": [ { "name": "ListenerId", "type": "string", "required": true, "description": "需要修改的监听器ID", "example": "listener-o0f3at99" }, { "name": "ListenerName", "type": "string", "required": true, "description": "新的监听器名称", "example": "‘test-2’" }, { "name": "ProxyId", "type": "string", "required": false, "description": "通道ID", "example": "link-3d85gh" } ], "required": [ "ListenerId", "ListenerName" ] }, { "name": "ModifyHTTPSListenerAttribute", "description": "该接口（ModifyHTTPSListenerAttribute）用于修改HTTPS监听器配置，当前不支持通道组和v1版本通道。", "status": "online", "parameters": [ { "name": "ListenerId", "type": "string", "required": true, "description": "监听器ID", "example": "listener-o0f3at99" }, { "name": "ProxyId", "type": "string", "required": false, "description": "通道ID， 若为单通道监听器，此项必须填写", "example": "link-3d85gh" }, { "name": "ListenerName", "type": "string", "required": false, "description": "修改后的监听器名称", "example": "test-2" }, { "name": "ForwardProtocol", "type": "string", "required": false, "description": "监听器后端转发与源站之间的协议类型", "example": "HTTP" }, { "name": "CertificateId", "type": "string", "required": false, "description": "修改后的监听器服务器证书ID", "example": "string" }, { "name": "ClientCertificateId", "type": "string", "required": false, "description": "修改后的监听器客户端证书ID，不支持多客户端证书，多客户端证书新采用PolyClientCertificateIds字段", "example": "string" }, { "name": "PolyClientCertificateIds", "type": "array", "required": false, "description": "新字段,修改后的监听器客户端证书ID", "example": "[\"casdfg\\n\"]", "item_type": "string" } ], "required": [ "ListenerId" ] }, { "name": "ModifyProxiesAttribute", "description": "本接口（ModifyProxiesAttribute）用于修改实例的属性（目前只支持修改通道的名称）。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": false, "description": "（旧参数，请切换到ProxyIds）一个或多个待操作的通道ID。", "example": "[\"link-sfsa\"]", "item_type": "string" }, { "name": "ProxyName", "type": "string", "required": false, "description": "通道名称。可任意命名，但不得超过32个字符。", "example": "proxy-name" }, { "name": "ClientToken", "type": "string", "required": false, "description": "用于保证请求幂等性的字符串。该字符串由客户生成，需保证不同请求之间唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。 更多详细信息请参阅：如何保证幂等性。", "example": "hjkhkljhjkl34534gfdsgfd" }, { "name": "ProxyIds", "type": "array", "required": false, "description": "（新参数）一个或多个待操作的通道ID。", "example": "[\"link-11112222\",\"link-11113333\"]", "item_type": "string" } ], "required": [] }, { "name": "ModifyProxiesProject", "description": "本接口（ModifyProxiesProject）用于修改通道所属项目。", "status": "online", "parameters": [ { "name": "ProjectId", "type": "integer", "required": true, "description": "需要修改到的项目ID。", "example": "1" }, { "name": "InstanceIds", "type": "array", "required": false, "description": "（旧参数，请切换到ProxyIds）一个或多个待操作的通道ID。", "example": "[\"link-11112222\"]", "item_type": "string" }, { "name": "ClientToken", "type": "string", "required": false, "description": "用于保证请求幂等性的字符串。该字符串由客户生成，需保证不同请求之间唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。 更多详细信息请参阅：如何保证幂等性。", "example": "wrqddadsda234134" }, { "name": "ProxyIds", "type": "array", "required": false, "description": "（新参数）一个或多个待操作的通道ID。", "example": "[\"link-11112222\",\"link-11113333\"]", "item_type": "string" } ], "required": [ "ProjectId" ] }, { "name": "ModifyProxyConfiguration", "description": "本接口（ModifyProxyConfiguration）用于修改通道的配置。根据当前业务的容量需求，扩容或缩容相关通道的配置。仅支持Scalarable为1的通道,Scalarable可通过接口DescribeProxies获取。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": false, "description": "（旧参数，请切换到ProxyId）通道的实例ID。", "example": "link-4ftf12sb" }, { "name": "Bandwidth", "type": "integer", "required": false, "description": "需要调整到的目标带宽，单位：Mbps。Bandwidth与Concurrent必须至少设置一个。取值范围根据DescribeAccessRegionsByDestRegion接口获取得到", "example": "10" }, { "name": "Concurrent", "type": "integer", "required": false, "description": "需要调整到的目标并发值，单位：万。Bandwidth与Concurrent必须至少设置一个。取值范围根据DescribeAccessRegionsByDestRegion接口获取得到", "example": "2" }, { "name": "ClientToken", "type": "string", "required": false, "description": "用于保证请求幂等性的字符串。该字符串由客户生成，需保证不同请求之间唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。更多详细信息请参阅：如何保证幂等性。", "example": "fdeg3453gfdsg" }, { "name": "ProxyId", "type": "string", "required": false, "description": "（新参数）通道的实例ID。", "example": "link-4ftf12sb" }, { "name": "BillingType", "type": "integer", "required": false, "description": "计费方式 (0:按带宽计费，1:按流量计费 默认按带宽计费）", "example": "0" } ], "required": [] }, { "name": "ModifyProxyGroupAttribute", "description": "本接口（ModifyProxyGroupAttribute）用于修改通道组属性，目前仅支持修改通道组名称与项目ID。", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "需要修改的通道组ID。", "example": "lg-b7h4d02f" }, { "name": "GroupName", "type": "string", "required": false, "description": "修改后的通道组名称：不超过30个字符，否则修改失败。", "example": "newName" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "项目ID", "example": "0" } ], "required": [ "GroupId" ] }, { "name": "ModifyRealServerName", "description": "本接口（ModifyRealServerName）用于修改源站的名称", "status": "online", "parameters": [ { "name": "RealServerName", "type": "string", "required": true, "description": "源站名称", "example": "‘namexxx’" }, { "name": "RealServerId", "type": "string", "required": true, "description": "源站ID", "example": "rsxxxx" } ], "required": [ "RealServerName", "RealServerId" ] }, { "name": "ModifyRuleAttribute", "description": "本接口（ModifyRuleAttribute）用于修改转发规则的信息，包括健康检查的配置以及转发策略。", "status": "online", "parameters": [ { "name": "ListenerId", "type": "string", "required": true, "description": "监听器ID", "example": "listener-8fueuc9" }, { "name": "RuleId", "type": "string", "required": true, "description": "转发规则ID", "example": "rule-5g8dh58" }, { "name": "Scheduler", "type": "string", "required": false, "description": "监听器源站访问策略，其中：rr表示轮询；wrr表示加权轮询；lc表示最小连接数；lrtt表示最小时延。", "example": "rr" }, { "name": "HealthCheck", "type": "integer", "required": false, "description": "源站健康检查开关，其中： 1，开启； 0，关闭。", "example": "0" }, { "name": "CheckParams", "type": "object", "required": false, "description": "健康检查配置参数", "example": "{\"Path\":\"/check_path\"}", "children": [ { "name": "DelayLoop", "type": "integer", "required": true, "description": "健康检查的时间间隔", "example": "30" }, { "name": "ConnectTimeout", "type": "integer", "required": true, "description": "健康检查的响应超时时间", "example": "2" }, { "name": "Path", "type": "string", "required": true, "description": "健康检查的检查路径", "example": "\"/\"" }, { "name": "Method", "type": "string", "required": true, "description": "健康检查的方法，GET/HEAD", "example": "\"HEAD\"" }, { "name": "StatusCode", "type": "array", "required": true, "description": "确认源站正常的返回码，可选范围[100, 200, 300, 400, 500]", "example": "[100, 200, 300, 400, 500]", "item_type": "integer" }, { "name": "Domain", "type": "string", "required": false, "description": "健康检查的检查域名。 当调用ModifyRuleAttribute时，不支持修改该参数。", "example": "\"www.qq.com\"" }, { "name": "FailedCountInter", "type": "integer", "required": false, "description": "源站服务失败统计频率", "example": "60" }, { "name": "FailedThreshold", "type": "integer", "required": false, "description": "源站健康性检查阀值，超过该阀值会屏蔽服务", "example": "5" }, { "name": "BlockInter", "type": "integer", "required": false, "description": "源站健康性检测超出阀值后，屏蔽的时间", "example": "600" } ] }, { "name": "Path", "type": "string", "required": false, "description": "转发规则路径", "example": "/path" }, { "name": "ForwardProtocol", "type": "string", "required": false, "description": "加速通道转发到源站的协议类型，支持：default, HTTP和HTTPS。 当ForwardProtocol=default时，表示使用对应监听器的ForwardProtocol。", "example": "default" }, { "name": "ForwardHost", "type": "string", "required": false, "description": "回源Host。加速通道转发到源站的请求中携带的host。 当ForwardHost=default时，使用规则的域名，其他情况为该字段所设置的值。", "example": "www.baidu.com" }, { "name": "ServerNameIndicationSwitch", "type": "string", "required": false, "description": "服务器名称指示（ServerNameIndication，简称SNI）开关。ON表示开启，OFF表示关闭。", "example": "OFF" }, { "name": "ServerNameIndication", "type": "string", "required": false, "description": "服务器名称指示（ServerNameIndication，简称SNI），当SNI开关打开时，该字段必填。", "example": "www.qq.com" }, { "name": "ForcedRedirect", "type": "string", "required": false, "description": "HTTP强制跳转HTTPS。输入当前规则对应的域名与地址。", "example": "https://www.qq.com/url" } ], "required": [ "ListenerId", "RuleId" ] }, { "name": "ModifySecurityRule", "description": "修改安全策略规则名", "status": "online", "parameters": [ { "name": "RuleId", "type": "string", "required": true, "description": "规则ID", "example": "sr-xxxx" }, { "name": "AliasName", "type": "string", "required": true, "description": "规则名：不得超过30个字符，超过部分会被截断。", "example": "t3" }, { "name": "PolicyId", "type": "string", "required": true, "description": "安全策略ID", "example": "sp-xxxx" }, { "name": "RuleAction", "type": "string", "required": false, "description": "安全规则动作", "example": "ACCEPT" }, { "name": "SourceCidr", "type": "string", "required": false, "description": "规则关联地址，格式需要满足CIDR网络地址规范", "example": "180.180.180.180/8" }, { "name": "Protocol", "type": "string", "required": false, "description": "协议类型", "example": "TCP" }, { "name": "DestPortRange", "type": "string", "required": false, "description": "端口范围，支持以下格式 单个端口: 80 多个端口: 80,443 连续端口: 3306-20000 所有端口: ALL", "example": "ALL" } ], "required": [ "RuleId", "AliasName", "PolicyId" ] }, { "name": "ModifyTCPListenerAttribute", "description": "本接口（ModifyTCPListenerAttribute）用于修改通道实例下TCP监听器配置，包括健康检查的配置，调度策略。", "status": "online", "parameters": [ { "name": "ListenerId", "type": "string", "required": true, "description": "监听器ID", "example": "listener-o0f3at99" }, { "name": "GroupId", "type": "string", "required": false, "description": "通道组ID，ProxyId和GroupId必须设置一个，但不能同时设置。", "example": "lg-bjkpdum1" }, { "name": "ProxyId", "type": "string", "required": false, "description": "通道ID，ProxyId和GroupId必须设置一个，但不能同时设置。", "example": "link-bjkpdum1" }, { "name": "ListenerName", "type": "string", "required": false, "description": "监听器名称", "example": "test10" }, { "name": "Scheduler", "type": "string", "required": false, "description": "监听器源站访问策略，其中：rr表示轮询；wrr表示加权轮询；lc表示最小连接数；lrtt表示最小时延。注意：lrtt需要开通白名单；RealServerType 为 DOMAIN 不支持wrr 和 lrtt。", "example": "rr" }, { "name": "DelayLoop", "type": "integer", "required": false, "description": "源站健康检查时间间隔，单位：秒。时间间隔取值在[5，300]之间。", "example": "30" }, { "name": "ConnectTimeout", "type": "integer", "required": false, "description": "源站健康检查响应超时时间，单位：秒。超时时间取值在[2，60]之间。超时时间应小于健康检查时间间隔DelayLoop。", "example": "20" }, { "name": "HealthCheck", "type": "integer", "required": false, "description": "是否开启健康检查，1开启，0关闭。", "example": "1" }, { "name": "FailoverSwitch", "type": "integer", "required": false, "description": "源站是否开启主备模式：1开启，0关闭，DOMAIN类型源站不支持开启", "example": "0" }, { "name": "HealthyThreshold", "type": "integer", "required": false, "description": "健康阈值，表示连续检查成功多少次数后认定源站健康。范围为1到10", "example": "5" }, { "name": "UnhealthyThreshold", "type": "integer", "required": false, "description": "不健康阈值，表示连续检查失败次数后认定源站不健康。范围为1到10", "example": "1" } ], "required": [ "ListenerId" ] }, { "name": "ModifyUDPListenerAttribute", "description": "本接口（ModifyUDPListenerAttribute）用于修改通道实例下UDP监听器配置，包括监听器名称和调度策略的修改。", "status": "online", "parameters": [ { "name": "ListenerId", "type": "string", "required": true, "description": "监听器ID", "example": "listener-o0f3at99" }, { "name": "GroupId", "type": "string", "required": false, "description": "通道组ID，ProxyId和GroupId必须设置一个，但不能同时设置。", "example": "lg-xxx" }, { "name": "ProxyId", "type": "string", "required": false, "description": "通道ID，ProxyId和GroupId必须设置一个，但不能同时设置。", "example": "link-bjkpdum1" }, { "name": "ListenerName", "type": "string", "required": false, "description": "监听器名称", "example": "test10" }, { "name": "Scheduler", "type": "string", "required": false, "description": "监听器源站访问策略，其中：rr表示轮询；wrr表示加权轮询；lc表示最小连接数；lrtt表示最小时延。", "example": "rr" }, { "name": "DelayLoop", "type": "integer", "required": false, "description": "源站健康检查时间间隔，单位：秒。时间间隔取值在[5，300]之间。", "example": "20" }, { "name": "ConnectTimeout", "type": "integer", "required": false, "description": "源站健康检查响应超时时间，单位：秒。超时时间取值在[2，60]之间。超时时间应小于健康检查时间间隔DelayLoop。", "example": "20" }, { "name": "HealthyThreshold", "type": "integer", "required": false, "description": "健康阈值，表示连续检查成功多少次后认定源站健康。范围为1到10", "example": "5" }, { "name": "UnhealthyThreshold", "type": "integer", "required": false, "description": "不健康阈值，表示连续检查失败多少次数后认为源站不健康。范围为1到10", "example": "1" }, { "name": "FailoverSwitch", "type": "integer", "required": false, "description": "源站是否开启主备模式：1开启，0关闭，DOMAIN类型源站不支持开启", "example": "0" }, { "name": "HealthCheck", "type": "integer", "required": false, "description": "源站是否开启健康检查：1开启，0关闭。", "example": "1" }, { "name": "CheckType", "type": "string", "required": false, "description": "UDP源站健康类型。PORT表示检查端口，PING表示PING。", "example": "PING" }, { "name": "CheckPort", "type": "integer", "required": false, "description": "UDP源站健康检查探测端口。", "example": "8888" }, { "name": "ContextType", "type": "string", "required": false, "description": "UDP源站健康检查端口探测报文类型：TEXT表示文本。仅在健康检查类型为PORT时使用。", "example": "TEXT" }, { "name": "SendContext", "type": "string", "required": false, "description": "UDP源站健康检查端口探测发送报文。仅在健康检查类型为PORT时使用。", "example": "helloworld" }, { "name": "RecvContext", "type": "string", "required": false, "description": "UDP源站健康检查端口探测接收报文。仅在健康检查类型为PORT时使用。", "example": "helloworld" } ], "required": [ "ListenerId" ] }, { "name": "OpenProxies", "description": "该接口（OpenProxies）用于开启一条或者多条通道。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": false, "description": "（旧参数，请切换到ProxyIds）通道的实例ID列表。", "example": "[\"link-11112222\",\"link-11113333\"]", "item_type": "string" }, { "name": "ClientToken", "type": "string", "required": false, "description": "用于保证请求幂等性的字符串。该字符串由客户生成，需保证不同请求之间唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。 更多详细信息请参阅：如何保证幂等性。", "example": "dfasfdsa454356" }, { "name": "ProxyIds", "type": "array", "required": false, "description": "（新参数）通道的实例ID列表。", "example": "[\"link-11112222\",\"link-11113333\"]", "item_type": "string" } ], "required": [] }, { "name": "OpenProxyGroup", "description": "该接口（OpenProxyGroup）用于开启一条通道组中的所有通道", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "通道组实例 ID", "example": "lg-11112222" } ], "required": [ "GroupId" ] }, { "name": "OpenSecurityPolicy", "description": "开启安全策略", "status": "online", "parameters": [ { "name": "ProxyId", "type": "string", "required": false, "description": "需开启安全策略的通道ID", "example": "link-4324dqse" }, { "name": "PolicyId", "type": "string", "required": false, "description": "安全策略ID", "example": "policy-adddasd" } ], "required": [] }, { "name": "RemoveRealServers", "description": "删除已添加的源站(服务器)IP或域名", "status": "online", "parameters": [ { "name": "RealServerIds", "type": "array", "required": true, "description": "源站Id列表", "example": "[\"rs-fgerw3dt\\n\"]", "item_type": "string" } ], "required": [ "RealServerIds" ] }, { "name": "SetAuthentication", "description": "本接口（SetAuthentication）用于通道的高级认证配置，包括认证方式选择，以及各种认证方式对应的证书选择。仅支持Version3.0的通道。", "status": "online", "parameters": [ { "name": "ListenerId", "type": "string", "required": true, "description": "监听器ID。", "example": "0" }, { "name": "Domain", "type": "string", "required": true, "description": "需要进行高级配置的域名，该域名为监听器下的转发规则的域名。", "example": "a.a.com" }, { "name": "BasicAuth", "type": "integer", "required": false, "description": "基础认证开关，其中： 0，关闭基础认证； 1，开启基础认证。 默认为0。", "example": "1" }, { "name": "GaapAuth", "type": "integer", "required": false, "description": "通道认证开关，用于源站对Gaap的认证，其中： 0，关闭通道认证； 1，开启通道认证。 默认为0。", "example": "1" }, { "name": "RealServerAuth", "type": "integer", "required": false, "description": "源站认证开关，用于Gaap对服务器的认证，其中： 0，关闭源站认证； 1，开启源站认证。 默认为0。", "example": "0" }, { "name": "BasicAuthConfId", "type": "string", "required": false, "description": "基础认证配置ID，从证书管理页获取。", "example": "conf-fdsajl234" }, { "name": "GaapCertificateId", "type": "string", "required": false, "description": "通道SSL证书ID，从证书管理页获取。", "example": "cert-sfjdslj23423" }, { "name": "RealServerCertificateId", "type": "string", "required": false, "description": "源站CA证书ID，从证书管理页获取。源站认证时，填写该参数或RealServerCertificateId参数", "example": "cert-sfjdslj23423" }, { "name": "RealServerCertificateDomain", "type": "string", "required": false, "description": "该字段已废弃，请使用创建规则和修改规则中的SNI功能。", "example": "cert-sfjdslj23423" }, { "name": "PolyRealServerCertificateIds", "type": "array", "required": false, "description": "多源站CA证书ID，从证书管理页获取。源站认证时，填写该参数或RealServerCertificateId参数", "example": "[“cert-sfjdslj23423”]", "item_type": "string" }, { "name": "TLSSupportVersion", "type": "array", "required": false, "description": "TLS支持的版本 支持TLSv1，TLSv1.1,TLSv1.2,TLSv1.3", "example": "['TLSv1', 'TLSv1.1']", "item_type": "string" }, { "name": "TLSCiphers", "type": "string", "required": false, "description": "支持的TLS密码套件，可选值为： [GAAP_TLS_CIPHERS_WIDE,GAAPTLS_CIPHERS_GENERAL,GAAPTLS_CIPHERS_STRICT]", "example": "GAAP_TLS_CIPHERS_WIDE" } ], "required": [ "ListenerId", "Domain" ] }, { "name": "SetTlsVersion", "description": "设置监听器TLS配置", "status": "online", "parameters": [ { "name": "ListenerId", "type": "string", "required": true, "description": "监听器ID", "example": "listener-dsdd" }, { "name": "TLSSupportVersion", "type": "array", "required": true, "description": "TLS版本,可选TLSv1、TLSv1.1、TLSv1.2、TLSv1.3", "example": "[\"TLSv1.2\", \"TLSv1.3\"]", "item_type": "string" }, { "name": "TLSCiphers", "type": "string", "required": true, "description": "密码套件包,可选 GAAP_TLS_CIPHERS_STRICT，GAAP_TLS_CIPHERS_GENERAL，GAAP_TLS_CIPHERS_WIDE(默认)", "example": "GAAP_TLS_CIPHERS_GENERAL" } ], "required": [ "ListenerId", "TLSSupportVersion", "TLSCiphers" ] } ] }