接口描述：调用本接口查询用户下自定义日志配置ID列表 请求方式：get 请求路径：/usercustomlogconfig/listid 使用说明： 单个用户一分钟限制调用10000次，并发不超过100 请求参数说明： 无 返回参数说明： 参数 类型 是否必传 名称及描述 code int 是 状态码，成功100000 message string 是 描述信息，成功返回success，其他返回异常信息描述 data object 否 返回结果 data.logformatid list 否 日志配置ID列表 示例： 请求路径： 示例1： 请求： 返回结果： json { "code": 100000, "message": "success", "data": { "logformatid": [ 11901 ] } } 错误码请参考：参数code和message含义

参数 类型 是否必传 名称及描述 code int 是 状态码 message string 是 描述信息 result list< object> 否 返回结果数组 result[].domain string 否 域名 result[].details list< object> 否 域名对应的vip列表信息 result[].details[ ].vips string 否 vip信息，多个用逗号“,”分割 result[].details[ ].cityName string 否 城市名称 result[].details[ ].nodename string 否 节点名称 result[].details[ ].provinceName string 否 省份名 result[].details[ ].ispName string 否 运营商名称

接口描述：调用本接口查询IP可用状态 请求方式：get 请求路径：/ip/queryipstatus 使用说明： 单个用户一分钟限制调用10000次，并发不超过100 请求参数说明： 参数 是否必填 参数类型 说明 示例 下级对象 vips 是 string vip列表，最多支持10个ip查询，多IP使用逗号分隔。若超过限制，则只返回最前面的10个。 1.1.1.1 返回参数说明： 参数 是否必填 参数类型 说明 示例 下级对象 code 是 int 状态码 成功100000 message 是 string 信息描述 成功返回success，其他返回异常信息描述 result 否 list 节点IP地址状态列表 resultsingle 表resultsingle 参数 是否必填 参数类型 说明 示例 下级对象 ip 否 string 节点ip地址 1.1.1.1 status 否 string ip状态，normal（正常），abnormal（非正常），noctyun（非天翼云ip） normal 示例： 请求路径： 示例1： 请求： 返回结果： json { "result": [ { "ip": "1.1.1.1", "status": "noctyun" }, { "ip": "2.2.2.2", "status": "noctyun" } ], "code": 100000, "message": "success" } 错误码请参考：参数code和message含义

参数 类型 是否必传 名称及描述 code int 是 状态码 message string 是 描述信息 result list< object> 否 返回结果数组 result[].ispid int 否 运营商ID result[].ispcode int 否 运营商编码 result[].ispcnname string 否 运营商中文名称 result[].ispenname string 否 运营商英文名称 result[].ispabbr string 否 运营商缩写

本文介绍图片渐进式加载的具体使用参数及示例。 访问网站时，普通图片的加载是随着下载图片数据的完成度，逐渐从上至下显示完成的。如果浏览器只收到了图片文件数据的一半，则只会显示图片的上半部分。而渐进式图片则是先显示图片整体的模糊效果，随着下载数据的增多，逐渐细化图片中的各个细节，使得图片分辨率逐渐提高，最终还原出完整清晰的图像内容。 开通图片处理后，客户可通过URL请求中携带指定参数，将原图转换为渐进式加载格式，从而优化网站表现。 注意 图片处理为付费服务，目前处于公测期间，暂不收取费用，收费时间另行通知。 参数说明及示例 参数名称：progressive。 访问示例：将原图做渐进式加载时，图片处理的访问URL为： 注意 目前图片渐进式加载仅支持JPEG（含JPG）和PNG格式。

项目 描述 语法 capturestable, err ctyun.re.match(subject, regex, options?) 作用 正则匹配，返回匹配内容。 入参 subject：待匹配字符串。 regex：正则表达式。 options：控制如何执行匹配操作，支持以下选项： a anchored mode (only match from the beginning) d enable the DFA mode (or the longest token match semantics). this requires PCRE 6.0+ or else a Lua exception will be thrown. first introduced in ngxlua v0.3.1rc30. D enable duplicate named pattern support. This allows named subpattern names to be repeated, returning the captures in an arraylike Lua table. for example, local m ngx.re.match("hello, world", "(?w+), (?w+)", "D") m["named"] {"hello", "world"} this option was first introduced in the v0.7.14 release. this option requires at least PCRE 8.12. i case insensitive mode (similar to Perl's /i modifier) j enable PCRE JIT compilation, this requires PCRE 8.21+ which must be built with the enablejit option. for optimum performance, this option should always be used together with the 'o' option. first introduced in ngxlua v0.3.1rc30. J enable the PCRE Javascript compatible mode. this option was first introduced in the v0.7.14 release. this option requires at least PCRE 8.12. m multiline mode (similar to Perl's /m modifier) o compileonce mode (similar to Perl's /o modifier), to enable the workerprocesslevel compiledregex cache s singleline mode (similar to Perl's /s modifier) u UTF8 mode. this requires PCRE to be built with the enableutf8 option or else a Lua exception will be thrown. U similar to "u" but disables PCRE's UTF8 validity check on the subject string. first introduced in ngxlua v0.8.1. x extended mode (similar to Perl's /x modifier) 返回值 capturestable：找到匹配项时，返回一个lua table，其中capturestable[0]保存整个匹配的子字符串，capturestable[1]保存第一个带括号的子模式的捕获，capturestable[2]为第二个，以此类推。未找到匹配项时此项为nil。 err：描述错误信息的字符串。

示例： 请求路径： 示例1： 请求： 返回结果： { "code": 100000, "message": "success", "total": 1, "page": 1, "pagesize": 1, "result": [ { "submittime": "20190506 12:00:00", "url": " "status": "completed", "headers": [ { "name": "test", "value": "111" }, { "name": "test2", "value": "222" } ] } ] } 错误码请参考：参数code和message含义

项目 描述 语法 number ctyun.worker.count() 作用 获取当前Nginx worker进程的数量，即Nginx配置中workerprocesses的值。 入参 无。 返回值 number：当前Nginx worker进程的数量。

接口描述：调用本接口查询绑定某证书的域名列表。 请求方式：get 请求路径：/cert/querycertbind 使用说明： 单个用户一分钟限制调用10000次，并发不超过100。 请求参数说明（json）： 参数 类型 是否必传 名称 描述 ::::: name string 是 证书备注名 返回参数说明： 参数 类型 是否必传 名称及描述 :::: code int 是 状态码 message string 是 描述信息 result list 否 绑定证书的域名列表 示例： 请求路径： 示例1： 请求： 返回结果： json { "code": 100000, "message": "success", "result": [ "a.ctyun.cn", "b.ctyun.cn", "c.ctyun.cn" ] } 错误码请参考：参数code和message含义

接口描述：调用本接口创建证书。 请求方式：post 请求路径：/cert/creatcert 使用说明： 单个用户一分钟限制调用10000次，并发不超过100； 请求参数说明（json）： 参数 类型 是否必传 名称 描述 certtype integer 否 证书类型 0（国际标准证书），1（国密证书），不传默认0 name string 是 证书备注名 key string 是 国际标准证书/国密加密证书私钥 仅支持PEM格式 certs string 是 国际标准证书/国密加密证书公钥 仅支持PEM格式 signkey string 否 国密签名证书私钥 仅支持PEM格式，当certtype1时，必传 signcerts string 否 国密签名证书公钥 仅支持PEM格式，当certtype1时，必传 返回参数说明： 参数 类型 是否必传 名称及描述 code int 是 状态码 message string 是 描述信息 id int 是 证书id 示例： 请求路径： 示例1： 请求参数： plaintext { "certtype": 1, "name": "国密证书", "certs": "certsxxx", "key": "keyxxx", "signkey": "enckeyxxx", "signcerts": "enccertsxxx" } 返回结果： plaintext { "code": 100000, "message": "success", "id": 7028 } 错误码请参考：参数code和message含义

接口描述：调用本接口进行域名归属权校验 请求方式：get 请求路径：/domain/verifydomainownership 使用说明： 单个用户一分钟限制调用10000次，并发不超过100 请求参数说明（json）： 参数名 类型 是否必填 名称 说明 ::::: domain string 是 域名 域名 verifytype int 否 解析方法 1（DNS解析验证） ；2（文件验证） 。默认1 返回参数说明： 参数 类型 是否必传 名称及描述 :::: code int 是 状态码，成功100000 message string 是 描述信息，成功返回success，其他返回异常信息描述 verifyresult boolean 否 域名归属权校验结果，true（成功），false(失败) 示例： 请求路径： 示例1： 请求： 返回结果： json { "code": 100000, "message": "success", "verifyresult": false } 错误码请参考：参数code和message含义

本文介绍图片置灰功能的具体使用参数及示例。 在某些场景中（例如在特定纪念日时），网站需要对部分图片做置灰处理。 开通图片处理后，客户可通过URL请求中携带相关参数，将原图置灰。 注意 图片处理为付费服务，目前处于公测期间，暂不收取费用，收费时间另行通知。 参数说明及示例 参数名称：grayscale。 访问示例：将原图置灰时，图片处理的访问URL为：

body) ctyun.resp.setoutput(res.body) end

参数 描述 是否必选 URIscheme 用于传输请求的协议，当前所有API均采用HTTPS协议。 是 Endpoint 当前资源池或者通用的域名。 是 resourcepath 资源路径，也即API访问路径。从具体API的URI模块获取，例如“获取用户1信息”API的resourcepath为“/users/1”。 是 querystring 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“?”，形式为“参数名参数取值”，例如“?userID1”，表示查询用户ID为1的数据。 是

大洲 大洲编码 洲大区 洲大区编码 亚洲 200 中亚 303 亚洲 200 东亚 315 亚洲 200 东南亚 311 亚洲 200 南亚 305 亚洲 200 西亚 306 大洋洲 201 澳大利亚和新西兰 314 大洋洲 201 美拉尼西亚 312 大洋洲 201 密克罗尼西亚 320 大洋洲 201 波利尼西亚 309 非洲 202 北非 307 非洲 202 东非 304 非洲 202 中非 319 非洲 202 南部非洲 310 非洲 202 西非 308 欧洲 203 中欧 313 欧洲 203 东欧 301 欧洲 203 北欧 317 欧洲 203 南欧 318 欧洲 203 西欧 316 美洲 204 加勒比 300 美洲 204 中美洲 302 美洲 204 北美 321 美洲 204 南美 322

运营商 运营商编码（string型） 中国电信 001 中国联通 002 中国移动 003 中国铁通 004 教育网 005 鹏博士 006

项目 描述 语法 str ctyun.locattime() 作用 从nginx时间缓存，返回当前时间。 入参 无。 返回值 str: 返回nginx 缓存时间的本地时间（格式为 ）yyyymmdd hh:mm:ss。

项目 描述 语法 intval ctyun.crc32long(str) 作用 计算参数str的CRC32摘要，与ctyun.crc32short相比，其在相对较长的str输入(即长于30 ~ 60字节)上性能更好。结果与ctyun.crc32short完全相同。 入参 str：string，待加密字符串。 返回值 digest: 计算参数str的CRC32摘要。

项目 描述 语法 headers, err ctyun.resp.getheaders(maxheaders?, raw?) 作用 获取响应头。 入参 maxheaders : numbe类型，缺省为100， 表示最多返回头部数量，为0表示不限制。 raw : bool类型，缺省为false，false 表示表头名称转成纯小写。 返回值 headers : table，保存全部返回的响应头，重复响应头的值为table。 err：字符串类型，错误描述，正确时为nil。 注意：建议ctyun.req.enrollheaderback 回调函数内使用。

变量名 变量说明 示例 arg参数名 url中的某个具体参数的值。 比如：请求为： http参数名 某个请求头xxx的值。 比如：请求为： H "test: hello" H "headacc: 222"。 调用ctyun.var("httptest")返回“hello”。 调用ctyun.var("httpheadacc") 返回“222”。 注意： 如果xxx有破折号，通过var调用时，用下划线代替。 cookiexxx 请求cookie头中的name值。 使用方式同上。 scheme 请求使用的Web协议，“http” 或 “https”。 ctyun.var("scheme") 返回http。 serverprotocol 服务器的HTTP版本，通常为 “HTTP/1.0” 或 “HTTP/1.1”。 ctyun.var("serverprotocol") 返回HTTP/1.1。 timeiso8601 服务器时间的ISO 8610格式。 ctyun.var("timeiso8601") 返回 20220714T11:13:56+08:00。 timelocal 服务器时间。 ctyun.var("timelocal") 返回14/Jul/2022:11:13:56 +0800。 timehttp 服务器时间的http表示法。 ctyun.var("timehttp") 返回 Thu, 14 Jul 2022 03:13:56 GMT。 host 客户端请求的域名。 ctyun.var("host") 返回ctyun.cn。 requesturi 用户原始请求url包括查询参数。 比如：客户端发送请求uri为： /%E4%BD%A0%E5%A5%BD?tt123。 ctyun.var("requesturi") 返回/%E4%BD%A0%E5%A5%BD?tt123。 uri requesturi变量中不带查询参数部分，且进行urldecode。 比如：客户端发送请求uri为： /%E4%BD%A0%E5%A5%BD?tt123。 ctyun.var("uri") 返回 /你好。 querystring 查询参数, requesturi的参数部分。 比如：请求uri为： /hello?tt123&t2%E4%BD%A0%E5%A5%BD。 ctyun.var("querystring") 返回 tt123&t2%E4%BD%A0%E5%A5%BD。 requestmethod HTTP请求方法，通常为"GET"或"POST"等。 ctyun.var("requestmethod") 返回GET。 remoteaddr 返回客户端ip。 ctyun.var("remoteaddr") 返回172.21.51.44。 remoteport 客户端端口号。 ctyun.var("remoteport") 返回38966。 serveraddr 服务端ip。 ctyun.var("serveraddr") 返回172.21.51.88。 serverport 服务端端口号。 ctyun.var("serverport") 返回80。 isargs 是否有请求参数。 ctyun.var.isargs 返回 "?"或者空字符串。 args 请求参数。 ctyun.var.args 返回 "a1&b2&c3"。

函数库 函数名 全局 assert、error、ipairs、next、pairs、pcall、select、tonumber、tostring、type、unpack、xpcall。 math abs、acos、asin、atan、atan2、ceil、cos、cosh、deg、exp、fmod、floor、frexp、huge、ldexp、log、log10、max、min、modf、pi、pow、rad、random、 sin、sinh、sqrt、tan、tanh。 os clock、difftime、time。 string byte、char、find、format、gmatch、gsub、len、lower、match、reverse、sub、upper。 table insert、maxn、remove、sort。 bit arshift、band、bnot、bor、bswap、bxor、lshift、rol、ror、rsh。

本文介绍用户分析可支持的维度和查询方法。 分析维度说明 用户分析模块，支持客户对访问用户区域分布、访问运营商分布、独立IP访问数等维度，按域名、时间条件进行查询，并基于带宽、流量、访问次数、独立IP访问峰值(1小时统计)、日活跃IP总量进行分析。同时支持数据的下载。 访问用户区域分布 访问用户区域分布支持客户按域名、时间等搜索条件，对用户所在区域基于带宽、流量、访问次数进行分析。 访问运营商分布 访问运营商分布支持客户按域名、时间等搜索条件，对用户所属运营商基于带宽、流量、访问次数进行分析。 独立IP访问数 独立IP访问数支持客户按域名、时间等搜索条件，对独立IP访问峰值(1小时统计)、日活跃IP总量进行分析。

参数类型 参数 说明 取值范围 裁剪类型 mid 居中裁剪参数，需与参数w、h一起使用。 无。 裁剪类型 x 指定X、Y轴裁剪参数，指定裁剪起点横坐标，需与参数y、w、h一起使用，必填。 不能超出原图宽度，如x超出原图宽，将会返回原图。 裁剪类型 y 指定X、Y轴裁剪参数，指定裁剪起点纵坐标，需与参数x、w、h一起使用，必填。 不能超出原图高度，如y超出原图高，将会返回原图。 裁剪类型 g 九宫格裁剪参数，设置裁剪的原点位置。原点按照九宫格的形式分布，一共有九个位置可以设置，为每个九宫格的左上角顶点。 需与参数w、h一起使用。 NW：左上。 N：中上。 NE：右上。 W：左中。 M：中部。 E：右中。 SW：左下。 S：中下。 SE：右下。 超出上述值，裁剪不生效，将会返回原图。 裁剪宽和高 w 指定从原点开始向右的裁剪宽度。与居中裁剪、指定X、Y轴裁剪、九宫格裁剪参数一起使用。 不能超出原图宽度，如w超出原图宽，将会按照对应的宽最大值处理。 裁剪宽和高 h 指定从原点开始向下的裁剪高度。与居中裁剪、指定X、Y轴裁剪、九宫格裁剪参数一起使用。 不能超出原图高度，如h超出原图高，将会按照对应的高最大值处理。

本文介绍图片格式转换相关参数及示例。 开通图片处理后，客户可通过URL请求中携带格式转换参数，将原图转换为指定的图片格式。 注意 图片处理为付费服务，目前处于公测期间，暂不收取费用，收费时间另行通知。 参数说明 支持的原图格式：JPEG、PNG、WEBP、BMP、GIF、TIFF、JPEG2000（JP2）；未在上述格式范围内，将会返回原图。 参数名称：format。 支持的参数值： 支持转换的图片格式 说明 JPEG 将原图保存为JPG或JPEG格式。 PNG 将原图保存为PNG格式。 WEBP 将原图保存为WEBP格式。 BMP 将原图保存为BMP格式。 GIF 将原图保存为GIF格式。注意：GIF为动图格式，如由其他静态格式转换而来，则仅转换为静图效果。 TIFF 将原图保存为TIFF格式。 JP2 将原图保存为JP2格式。 JXR 将原图保存为JXR格式。 注意 以上参数值不区分大小写。 参数示例

本文介绍图片缩放具体使用参数及示例。 开通图片处理后，客户可通过url请求中携带图片缩放参数，将原图转换为指定比例的图片。 注意 图片处理为付费服务，目前处于公测期间，暂不收取费用，收费时间另行通知。 参数说明及示例 参数名称：resize。 支持的参数值如下： 参数 说明 取值范围 示例 w 按宽固定自适应等比缩放: 固定宽度，高度自适应。 缩放后的宽×高不能超过16777216 px。 h 按高固定自适应等比缩放: 固定高度，宽边自适应。 缩放后的宽×高不能超过16777216 px。 l 按长边固定自适应等比缩放：长边固定长度，短边自适应缩放。 缩放后的宽×高不能超过16777216 px。 s 按短边固定自适应等比缩放：短边固定长度，长边自适应缩放 缩放后的宽×高不能超过16777216 px。 。 fw、fh 指定目标缩放图的宽高。 缩放后的宽×高不能超过16777216 px。 。 p 按原图宽高比例进行缩放。 0

来自：

帮助文档

CDN加速

用户指南

域名管理

文件处理

图片处理

图片缩放

本文介绍账单查询的方法。 简要说明 天翼云支持用户查询账单概览、流水账单、账单详情及导出记录。 查询步骤 1. 登录天翼云账户，单击右上角，再单击【费用中心】。 2. 选择【账单管理】，分别单击【账单概览】、【流水账单】、【账单详情】、【导出记录】查询不同维度的账单。 账单概览 账单概览可以展示用户的消费汇总、应付金额、实付金额等数据。 1. 账单概览可显示近6个月消费汇总情况。 2. 选择【账期】，可查看单月消费概况，并支持导出两种格式（XLSX、CSV）的账单，可在“导出记录”下载。 3. 汇总图表和表格，用户可按产品类型、企业项目、计费模式查看汇总数据。 流水账单 流水账单可以展示按照不同计费模式和账期维度构成的数据，并可导出两种格式（XLSX、CSV）的账单，在“导出记录”下载。 1. 支持按计费模式（包周期、按需、全部）、账期等过滤条件查看流水账单数据，同时支持导出格式为XLSX、CSV的账单。 2. 支持通过单击导出按钮左侧的【列设置】，自定义规划需要展示的列项，实现自定义查询账单。

参数 类型 是否必传 名称及描述 code int 是 状态码 message string 是 描述信息 result dict 否 返回结果 result.max int 否 每日解封最大条数 result.used int 否 每日解封已使用条数 result.surplus int 否 每日解封剩余条数 result.singlecommitmax int 否 每次提交解封最大条数

本文介绍如何根据标头中的已知预共享密钥允许或拒绝请求。 根据标头中的已知预共享密钥允许或拒绝请求。 示例代码 javascript / @param {string} PRESHAREDAUTHHEADERKEY Custom header to check for key @param {string} PRESHAREDAUTHHEADERVALUE Hard coded key value / const PRESHAREDAUTHHEADERKEY "XCustomPSK" const PRESHAREDAUTHHEADERVALUE "mypresharedkey" async function handleRequest(request) { const psk request.headers.get(PRESHAREDAUTHHEADERKEY) if (psk PRESHAREDAUTHHEADERVALUE) { // Correct preshared header key supplied. Fetch request from origin. return fetch(request) } // Incorrect key supplied. Reject the request. return new Response("Sorry, you have supplied an invalid key.", { status: 403, }) } addEventListener("fetch", event > { event.respondWith(handleRequest(event.request)) }) 示例预览 在请求过程中不带密钥访问，请求被拒绝。 相关参考 运行时API：addEventListener 运行时API：Response 运行时API：FetchEvent 运行时API：Web Standard 运行时API：Fetch

本文介绍函数运行时的addEventListener定义与用法。 此函数定义执行用户函数脚本的触发器。addEventListener仅支持注册一个事件监听器。当前仅支持fetch请求事件，通过注册fetch事件监听器，生成HTTP请求事件FetchEvent，进而实现对HTTP请求的处理。 定义 javascript addEventListener(type: string, listener: (event: FetchEvent) > void): void; 说明 如果注册多个"fetch"类型的监听器，当一个监听器未调用时event.respondWith()，运行时会将事件传递给下一个已注册的监听器。 如果对某个事件进行多次调用会形成调用链条。当某个回调函数调用respondWith函数时，调用链条会被终止，后面注册的回调函数不会再被调用。 参数 type string 事件类型，当前仅支持"fetch"，后续会支持"scheduled"。 listener function 事件监听器。用于处理事件回调。 示例 javascript // 注册请求事件监听器 addEventListener("fetch", event > { // 响应客户端请求 return event.respondWith( new Response("Hello world") ) }) 相关参考 示例代码：返回HTML页面 示例代码：返回JSON内容

分类 定义 状态码 错误详情 函数错误 脚本异常：用户函数抛出JavaScript异常 500 Error Code: 1111 Function threw exception 函数错误 禁止访问网络 500 Error Code: 1113 Prohibit access to the intranet 函数错误 超出6个子请求限制 500 Error Code: 1115 Too many subrequests 函数错误 函数没有返回 response 500 Error Code: 1117 Illegal response 资源限制 用户函数超出运行时资源限制： CPU执行时长≤配置的函数规格（10ms） 内存≤128M 响应时长≤30s 500 Error Code: 1201 Exceeded resource limits 内部错误 内部错误 500 Error Code: 1301 Internal Error 函数错误 函数被禁用 500 Error Code: 1407 Function Forbidden

本文介绍如何通过边缘函数将客户端请求重定向至指定URL。 重定向至指定URL。 示例代码 javascript const destinationURL " const statusCode 301 async function handleRequest(request) { return Response.redirect(destinationURL, statusCode) } addEventListener("fetch", async event > { event.respondWith(handleRequest(event.request)) }) 示例预览 响应301重定向到 。 相关参考 运行时API：addEventListener 运行时API：Response 运行时API：FetchEvent

本文介绍函数运行时的Encoding定义与用法。 基于 Web APIs 标准TextEncoder、TextDecoder进行设计，实现编码器与解码器。 TextEncoder TextEncoder 接口表示一个文本解码器，一个解码器只支持一种特定文本编码。传递给构造函数的参数将会被忽略，直接创建UTF8的TextEncoder。 TextEncoder()返回一个新构造的函数，该函数生成使用UTF8编码的字节流。详细定义请参见MDN官方文档TextEncoder。 构造函数 javascript let encoder new TextEncoder() 属性 encoding DOMString 只读，编码器使用的编码类型（始终为utf8）。 方法 encode( input USVString ) Uint8Array 对输入的字符串入进行编码。 TextDecoder 解码器。详细定义请参见MDN官方文档TextDecoder。 构造函数 javascript let decoder new TextDecoder() 属性 encoding DOMString 只读，解码器使用的编码类型。 fatal boolean 只读，表示错误模式是否致命。 ignoreBOM boolean 只读，表示是否忽略字节顺序标记。 方法 decode() DOMString 对输入的字符串入进行解码。 相关参考 示例代码：HMACSHA256签名摘要