更新可编程脚本。
接口说明
UpdateAScripts 接口属于异步接口,即系统返回一个请求 ID,但该可编程脚本尚未更新成功,系统后台的更新任务仍在进行。您可以调用 ListAScripts 查询可编程脚本的更新状态:
-
当可编程脚本处于 Configuring 状态时,表示可编程脚本正在更新中。
-
当可编程脚本处于 Available 状态时,表示可编程脚本更新成功。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ClientToken | string | 否 | 客户端 Token,用于保证请求的幂等性。 从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。 说明
若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
| b1f642ac-5558-4a36-b7d9-cf53****** |
DryRun | boolean | 否 | 是否只预检此次请求。取值:
| false |
AScripts | object [] | 否 | 可编程脚本信息列表。 | |
AScriptName | string | 否 | 可编程脚本名称。 长度为 2~128 个英文或中文字符,必须以大小写英文字母或中文开头,可包含数字,半角句号(.),下划线(_)和短划线(-)。 | Group1 |
Enabled | boolean | 否 | 是否启用可编程脚本。取值:
| true |
ScriptContent | string | 否 | 可编程脚本内容。 | if and(match_re($uri, '^/1.txt$'), $arg_type) { rewrite(concat('/1.', $arg_type), 'break') } |
ExtAttributes | object [] | 否 | 扩展属性 | |
AttributeKey | string | 是 | Ascript 脚本的属性名称。 仅取值 EsDebug:当请求携带_es_dbg 参数,且值为此处配置的密钥时,开启相应的调试响应头,以输出规则执行记录。 | EsDebug |
AttributeValue | string | 是 | 属性值,大小写英文字母或数字,长度为 1~128 个字符 | test123 |
AScriptId | string | 是 | 可编程脚本 ID。 | as-mhqxcanmivn4g5**** |
ExtAttributeEnabled | boolean | 否 | 是否启用可编程脚本扩展属性。取值:
| true |
返回参数
示例
正常返回示例
JSON
格式
{
"JobId": "2e82b5f4-1ba9-4d20-89c8-1082ebaa****",
"RequestId": "ACA19FE1-C09E-53C7-8FDA-560******"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | IncorrectStatus.Listener | The status of %s [%s] is incorrect. | 资源%s [%s]的状态无效。 |
400 | ResourceQuotaExceeded.AScriptsNum | The quota of %s is exceeded for resource %s, usage %s/%s. | 配额%s已超额度限制,目前已使用%s,配额为%s。 |
400 | ResourceQuotaExceeded.AScriptsTotalLinesNum | The quota of %s is exceeded for resource %s, usage %s/%s. | 配额%s已超额度限制,目前已使用%s,配额为%s。 |
400 | ResourceQuotaExceeded.AScriptLinesNum | The quota of %s is exceeded for resource %s, usage %s/%s. | 配额%s已超额度限制,目前已使用%s,配额为%s。 |
404 | ResourceNotFound.Ascript | The specified resource of %s is not found. | 资源%s不存在。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||
---|---|---|---|---|---|---|---|---|
2024-06-11 | OpenAPI 错误码发生变更 | 看变更集 | ||||||
| ||||||||
2024-06-11 | OpenAPI 错误码发生变更 | 看变更集 | ||||||
| ||||||||
2024-01-24 | OpenAPI 错误码发生变更 | 看变更集 | ||||||
| ||||||||
2024-01-18 | OpenAPI 错误码发生变更 | 看变更集 | ||||||
|