调用UpdateApplicationMonitor接口修改源站探测任务配置。
接口说明
UpdateApplicationMonitor 接口属于异步接口,即系统会先返回一个请求 ID,但源站探测任务并未修改完成,系统后台的修改任务仍在进行。您可以调用 DescribeApplicationMonitor 或 ListApplicationMonitor 查询源站探测任务的配置是否完成修改:
-
当修改的参数值未发生变更,表示源站探测任务正在修改中,在该情况下,您只能执行查询操作,不能执行其他操作。
-
当修改的参数值已发生变更,表示源站探测任务修改完成。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ga:UpdateApplicationMonitor | update |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 否 | 全球加速实例所属的地域 ID,仅取值:cn-hangzhou。 | cn-hangzhou |
ClientToken | string | 否 | 客户端 Token,用于保证请求的幂等性。 从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。 说明
若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
| 123e4567-e89b-12d3-a456-426655440000 |
TaskId | string | 是 | 需要修改源站探测的任务 ID。 | sm-bp1fpdjfju9k8yr1y**** |
ListenerId | string | 否 | 需要修改源站探测的监听实例 ID。 | lsr-bp1bpn0kn908w4nbw**** |
TaskName | string | 否 | 源站探测的任务名称。 名称长度为 1~128 个字符,以大小写字母或中文开头,可包含数字、半角句号(.)下划线(_)和短划线(-)。 | task1 |
Address | string | 否 | 需要探测的 URL 或 IP 地址。 | https://www.aliyun.com |
OptionsJson | string | 否 | 源站探测任务对应监听协议类型的高级扩展选项。不同源站探测任务的监听协议类型对应不同的扩展选项。 | { "http_method": "get","header": "key:asd","acceptable_response_code": "500","cert_verify": true } |
DetectEnable | boolean | 否 | 是否开启自动诊断功能。取值:
| false |
DetectThreshold | integer | 否 | 设置自动诊断触发阈值,当源站可用率低于设置的触发阈值,则自动触发诊断。 取值范围:0~100。 | 0 |
DetectTimes | integer | 否 | 触发自动诊断需要达到触发阈值的次数。 取值范围:1~20。 | 1 |
SilenceTime | integer | 否 | 自动诊断触发的沉默时间。表示自动诊断触发后,未恢复到正常,间隔多久触发一次自动诊断。 可用率连续多次(即设置的 DetectTimes)低于自动诊断触发阈值时,触发自动诊断,如果可用率在自动诊断触发的沉默时间内持续低于自动诊断触发阈值,在自动诊断触发的沉默时间内不会重复出发自动诊断;如果可用率在自动诊断触发的沉默时间后仍未恢复正常,则再次触发自动诊断。 单位:秒。取值范围:300~86400。 | 300 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidateTaskId.ApplicationMonitor | The application monitor task %s is not exist. | 源站探测任务ID不存在。 |
400 | NotExist.Listener | listener %s is not exist | 监听%s不存在。 |
400 | NotActive.Listener | listener %s is not active | 监听%s不可用。 |
400 | ListenerNotSupport.ApplicationMonitor | when the listener protocol is udp, application monitor is not supported. | 源站探测不支持配置协议为UDP的监听。 |
400 | InvalidatePort.ApplicationMonitor | The address port not in listener port range. | 源站探测域名端口不在监听端口范围之内。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-07-11 | OpenAPI 错误码发生变更 | 查看变更详情 |