停用后端服务器--边缘计算节点-火山引擎

文档中心

立即注册

导航

边缘计算节点

停用后端服务器

最近更新时间：2024.07.18 11:03:33首次发布时间：2024.07.02 10:22:48

本接口用于停用一个后端服务器组中的某个后端服务器。一条转发路径中配置的后端服务器构成一个后端服务器组。

请求说明

请求方式：POST
请求地址：https://veenedge.volcengineapi.com/?Action=StopGroupRs&Version=2021-04-30

请求参数

下表列出了接口特定的请求参数以及公共请求参数 Action 和 Version。其他公共参数，请参见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`StopGroupRs`	接口名称。当前 API 的名称为 `StopGroupRs`。
Version	String	是	`2021-04-30`	接口版本。当前 API 的版本为 `2021-04-30`。

Body

参数	类型	是否必选	示例值	描述
lb_identity	String	是	`veew-lb70204100444012074****`	负载均衡实例的 ID。您可以调用 ListLB7Instances 接口查询负载均衡实例的 ID。
group_identity	String	是	`res-0990754908540871****`	后端服务器组的 ID。您可以调用 ListRulePath 接口获取后端服务器组的 ID。
rs_identity	String	是	`veen0642211172016766****`	后端服务器的 ID。您可以调用 ListRulePath 接口获取后端服务器的 ID。
port	Integer	是	`80`	后端服务器的端口。

返回参数

该接口无特有的返回参数。

请求示例

POST https://veenedge.volcengineapi.com/?Action=StopGroupRs&Version=2021-04-30
{
    "lb_identity": "veew-lb70204100444012074****",
    "group_identity": "res-0990754908540871****",
    "rs_identity": "veen0642211172016766****",
    "port": 80
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202406172102312BC7A39AD84C8E05****",
        "Action": "StopGroupRs",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    },
    "Result": {}
}

错误码

如果响应正文中包含 Error 字段，则表示 API 请求失败。关于错误码的更多信息，参见错误码。