调用ConfigEndpointProbe接口配置终端节点时延探测。
接口说明
-
ConfigEndpointProbe 接口属于异步接口,即系统会先返回一个请求 ID,但终端节点时延探测并未配置完成,系统后台的配置任务仍在进行。您可以通过调用 DescribeEndpointGroup 查询终端节点组的状态,以确认终端节点组中终端节点的时延探测配置是否完成:
当终端节点组处于 updating 状态时,表示终端节点组中终端节点的时延探测正在配置中,在该状态下,您只能执行查询操作,不能执行其他操作。
当终端节点组处于 active 状态时,表示终端节点组中终端节点时延探测配置完成。
-
ConfigEndpointProbe 接口不支持在同一个全球加速实例内并发配置终端节点时延探测。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
ga:ConfigEndpointProbe |
update |
*EndpointGroup
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
是 |
全球加速实例所在的地域 ID,仅取值cn-hangzhou。 |
cn-hangzhou |
| ClientToken |
string |
否 |
客户端 Token,用于保证请求的幂等性。 从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。 说明
若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。 |
123e4567-e89b-12d3-a456-426655440000 |
| EndpointGroupId |
string |
是 |
终端节点组 ID。 |
epg-bp1dmlohjjz4kqaun**** |
| EndpointType |
string |
是 |
终端节点类型。取值:
|
Ip |
| Endpoint |
string |
是 |
终端节点。 |
127.0.XX.XX |
| ProbeProtocol |
string |
否 |
时延探测协议。取值:
|
tcp |
| ProbePort |
string |
否 |
时延探测端口。取值范围:0~65535。 |
80 |
| Enable |
string |
是 |
是否开启时延探测。取值:
|
true |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回列表信息。 |
||
| RequestId |
string |
请求 ID。 |
6FEA0CF3-D3B9-43E5-A304-D217037876A8 |
示例
正常返回示例
JSON格式
{
"RequestId": "6FEA0CF3-D3B9-43E5-A304-D217037876A8"
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | NotExist.EndPointGroup | endpoint group %s is not exist | 终端节点组%s不存在 |
| 400 | StateError.Accelerator | accelerator state %s is illegal | 加速实例状态%s非法 |
| 400 | StateError.EndPointGroup | endpoint group state %s is illegal | 终端节点组状态非法 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。