UpdateAScripts - 更新可编程脚本

更新可编程脚本。

接口说明

UpdateAScripts 接口属于异步接口,即系统返回一个请求 ID,但该可编程脚本尚未更新成功,系统后台的更新任务仍在进行。您可以调用 ListAScripts 查询可编程脚本的更新状态:

  • 当可编程脚本处于 Configuring 状态时,表示可编程脚本正在更新中。

  • 当可编程脚本处于 Available 状态时,表示可编程脚本更新成功。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
ClientTokenstring

客户端 Token,用于保证请求的幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
b1f642ac-5558-4a36-b7d9-cf53******
DryRunboolean

是否只预检此次请求。取值:

  • true:发送检查请求,不会更新可编程脚本。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation
  • false(默认值):发送正常请求,通过检查后返回 HTTP 2xx 状态码并直接进行操作。
false
AScriptsobject []

可编程脚本信息列表。

AScriptNamestring

可编程脚本名称。

长度为 2~128 个英文或中文字符,必须以大小写英文字母或中文开头,可包含数字,半角句号(.),下划线(_)和短划线(-)。

Group1
Enabledboolean

是否启用可编程脚本。取值:

  • true:启用。

  • false(默认值):不启用。

true
ScriptContentstring

可编程脚本内容。

if and(match_re($uri, '^/1.txt$'), $arg_type) { rewrite(concat('/1.', $arg_type), 'break') }
ExtAttributesobject []

扩展属性

AttributeKeystring

Ascript 脚本的属性名称。

仅取值 EsDebug:当请求携带_es_dbg 参数,且值为此处配置的密钥时,开启相应的调试响应头,以输出规则执行记录。

EsDebug
AttributeValuestring

属性值,大小写英文字母或数字,长度为 1~128 个字符

test123
AScriptIdstring

可编程脚本 ID。

as-mhqxcanmivn4g5****
ExtAttributeEnabledboolean

是否启用可编程脚本扩展属性。取值:

  • true:启用。

  • false(默认值):不启用

true

返回参数

名称类型描述示例值
object

更新可编程脚本。

JobIdstring

异步任务 ID。

2e82b5f4-1ba9-4d20-89c8-1082ebaa****
RequestIdstring

请求 ID。

ACA19FE1-C09E-53C7-8FDA-560******

示例

正常返回示例

JSON格式

{
  "JobId": "2e82b5f4-1ba9-4d20-89c8-1082ebaa****",
  "RequestId": "ACA19FE1-C09E-53C7-8FDA-560******"
}

错误码

HTTP status code错误码错误信息描述
400IncorrectStatus.ListenerThe status of %s [%s] is incorrect.资源%s [%s]的状态无效。
400ResourceQuotaExceeded.AScriptsNumThe quota of %s is exceeded for resource %s, usage %s/%s.配额%s已超额度限制,目前已使用%s,配额为%s。
400ResourceQuotaExceeded.AScriptsTotalLinesNumThe quota of %s is exceeded for resource %s, usage %s/%s.配额%s已超额度限制,目前已使用%s,配额为%s。
400ResourceQuotaExceeded.AScriptLinesNumThe quota of %s is exceeded for resource %s, usage %s/%s.配额%s已超额度限制,目前已使用%s,配额为%s。
404ResourceNotFound.AscriptThe specified resource of %s is not found.资源%s不存在。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-06-11OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
2024-06-11OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
2024-01-24OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    新增错误码:404
2024-01-18OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更