更新时间:2024-11-11 GMT+08:00
分享

更新终端节点

功能介绍

更新终端节点。

调用方法

请参见如何调用API

URI

PUT /v1/endpoint-groups/{endpoint_group_id}/endpoints/{endpoint_id}

表1 路径参数

参数

是否必选

参数类型

描述

endpoint_group_id

String

终端节点组ID。

endpoint_id

String

终端节点ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

表3 请求Body参数

参数

是否必选

参数类型

描述

endpoint

UpdateEndpointOption object

更新终端节点的详细信息。

表4 UpdateEndpointOption

参数

是否必选

参数类型

描述

weight

Integer

终端节点权重。

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

endpoint

EndpointDetail object

终端节点实例。

request_id

String

请求ID。

表6 EndpointDetail

参数

参数类型

描述

id

String

终端节点ID。

resource_id

String

对应后端资源ID。

endpoint_group_id

String

终端节点组ID。

resource_type

String

终端节点类型。

status

String

配置状态,取值:

  • ACTIVE:运行中

  • PENDING:待定

  • ERROR:错误

  • DELETING:正在删除

weight

Integer

终端节点权重。

health_state

String

终端的健康状态,取值:

  • INITIAL:初始

  • HEALTHY:正常

  • UNHEALTHY:异常

  • NO_MONITOR:未监控

created_at

String

创建时间。

updated_at

String

更新时间。

domain_id

String

租户ID。

ip_address

String

IP地址。

frozen_info

FrozenInfo object

云服务或资源实例冻结信息。

表7 FrozenInfo

参数

参数类型

描述

status

Integer

云服务或资源实例状态,取值:

  • 0:解冻/正常(云服务恢复正常)。

  • 1:冻结(资源和数据会保留,但租户无法再正常使用云服务)。

  • 2:删除/终止(资源和数据将清除)。

effect

Integer

在冻结/解冻操作下,取值:

  • 1(默认值):冻结可释放。

  • 2:冻结不可释放。

  • 3:冻结后不可续费。

scene

Array of strings

更新云服务状态的业务场景列表,取值:

  • ARREAR(默认值):欠费场景。为正常的运营业务场景,包括包周期资源到期、按需资源扣费失败。

  • POLICE:公安冻结场景。

  • ILLEGAL:违规冻结场景。

  • VERIFY:客户未实名认证冻结场景。

  • PARTNER:合作伙伴冻结(合作伙伴冻结子客户资源)。

请求示例

更新终端节点,将权重修改为5。

PUT https://{ga_endpoint}/v1/endpoint-groups/3a9f50bb-f041-4eac-a117-82472d8a0007/endpoints/0aa23a52-1ac2-4a2d-8dfa-1e11cb26079d

{
  "endpoint" : {
    "weight" : 5
  }
}

响应示例

状态码: 200

操作成功

{
  "endpoint" : {
    "id" : "0aa23a52-1ac2-4a2d-8dfa-1e11cb26079d",
    "resource_id" : "08155cd2-5897-49be-933f-eec757fd4010",
    "endpoint_group_id" : "3a9f50bb-f041-4eac-a117-82472d8a0007",
    "resource_type" : "EIP",
    "status" : "ACTIVE",
    "weight" : 5,
    "health_state" : "HEALTHY",
    "created_at" : "2019-01-08T01:21:37.151Z",
    "updated_at" : "2019-01-08T01:21:37.151Z",
    "domain_id" : "99a3fff0d03c428eac3678da6a7d0f24",
    "ip_address" : "208.182.11.121",
    "frozen_info" : {
      "status" : 2,
      "effect" : 1,
      "scene" : [ "ARREAR", "POLICE" ]
    }
  },
  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
}

状态码

状态码

描述

200

操作成功

错误码

请参见错误码

相关文档