更新服务。支持更新服务健康检查配置, DNS 域名和固定地址的地址配置信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| apig:UpdateService | none | *Service acs:apig:{#regionId}:{#accountId}:service/{#ServiceId} |
| 无 |
请求语法
PUT /v1/services/{serviceId} HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| serviceId | string | 否 | 服务 ID。 | svc-cr6pk4tlhtgm58e*** |
| body | object | 否 | 请求 Body。 | |
| addresses | array | 否 | 域名或固定地址列表。 | |
| string | 否 | 域名或固定地址。 | 127.0.0.1:8080 | |
| healthCheckConfig | object | 否 | 服务的健康检查配置。 | |
| enable | boolean | 否 | 是否开启服务的健康检查。 | true |
| protocol | string | 否 | 健康检查的协议。 枚举值:
| HTTP |
| timeout | integer | 否 | 健康检查响应超时时间。单位:秒。 | 2 |
| interval | integer | 否 | 健康检查间隔时间。单位:秒。 | 2 |
| healthyThreshold | integer | 否 | 健康检查健康阈值。 | 2 |
| unhealthyThreshold | integer | 否 | 健康检查不健康阈值。 | 22 |
| httpPath | string | 否 | 健康检查的请求路径。当协议为 HTTP 的时候,需要填写。 | /healthz |
| httpHost | string | 否 | 健康检查域名。可选。当协议为 HTTP 时候,可以配置。 | dev.itemcener.com |
| expectedStatuses | array | 否 | 请求返回正常状态码列表。当协议为 HTTP 时,需要配置。 | |
| string | 否 | 请求返回正常的状态码。 枚举值:
| 200 | |
| protocol | string | 否 | 服务的协议。 | HTTP |
| aiServiceConfig | AiServiceConfig | 否 | AI 服务配置 | |
| agentServiceConfig | AgentServiceConfig | 否 | Agent 服务配置 | |
| dnsServers | array | 否 | DNS 服务地址 | |
| string | 否 | DNS 服务地址 | 1.1.1.1 | |
| ports | array<object> | 否 | 端口信息。 | |
| object | 否 | 端口信息。 | ||
| name | string | 否 | 端口名称 | catalog |
| port | integer | 否 | 端口。 | 80 |
| protocol | string | 否 | 协议。 | TCP|UDP |
| healthyPanicThreshold | float | 否 | 健康检查阈值 | 80 |
| outlierDetectionConfig | object | 否 | 被动健康检查参数配置 | |
| enable | boolean | 否 | enable | false |
| baseEjectionTime | integer | 否 | 初始隔离时长,节点被弹出后的初始隔离时长(如 30 秒)。隔离时间计算公式:k * base_ejection_time(k 初始值为 1),每次弹出会延长隔离时间(k 加一),若连续检测正常则逐步缩短隔离时间(k 减一)。 | 30 |
| failurePercentageThreshold | integer | 否 | 失败率阈值,当某节点失败请求占比达到此阈值,系统将触发该节点的弹出机制。 | 80 |
| failurePercentageMinimumHosts | integer | 否 | 恐慌阈值 当服务中健康节点比例大于恐慌阈值的时候,健康检测正常生效,请求只被发送到健康节点,不发送到被弹出节点; 当服务中健康节点比例小于等于恐慌阈值的时候,健康检测相当于被禁用,请求被发送到所有节点,包括已被弹出节点。 | 1 |
| interval | integer | 否 | 检测间隔时间 | 30 |
返回参数
示例
正常返回示例
JSON格式
{
"requestId": "B725275B-50C6-5A49-A9FD-F0332FCB3351",
"code": "Ok",
"message": "success"
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2025-12-17 | 新增 OpenAPI | 查看变更详情 |
