设置边缘实例的会话超时时间--边缘计算节点-火山引擎

文档中心

立即注册

导航

边缘计算节点

设置边缘实例的会话超时时间

最近更新时间：2024.11.21 18:01:05首次发布时间：2024.11.21 18:01:05

本接口用于设置单个边缘实例的 UDP 会话超时时间。

使用说明

您可以通过 CreateCloudServer 接口设置 UDP 会话超时时间。该配置会对边缘服务下所有新创建的边缘实例生效。如果您需要设置单个边缘实例的 UDP 会话超时时间，可以使用 SetInstanceTimeout 接口。

请求说明

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

请求参数

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

Query

名称	类型	是否必选	示例值	描述
Action	String	是	SetInstanceTimeout	公共参数。该参数表示接口名称。取值：SetInstanceTimeout。
Version	String	是	2021-04-30	公共参数。该参数表示接口版本。取值：2021-04-30。

Body

名称	类型	是否必选	示例值	描述
instance_identity	String	是	veen1020125208252511****	边缘实例 ID。您可以通过 ListInstances 接口查询边缘实例 ID。
udp_timeout	Integer	否	60	边缘实例的 UDP 会话超时时间。如果已建立的 UDP 会话上一直没有数据传输，且该情况的持续时长达到设置的超时时间，边缘实例会清除会话的状态信息。取值范围：15~310。默认值：60。单位：秒。说明您需要提交工单开通“UDP 会话超时时间”功能后，该参数才可使用；否则参数值无效。

返回参数

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

请求示例

POST https://veenedge.volcengineapi.com/?Action=SetInstanceTimeout&Version=2021-04-30
&<其他公共参数>
{
    "instance_identity": "veen1020125208252511****",
    "udp_timeout": 60
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20241121165906D2F61463605DC89D****",
        "Action": "SetInstanceTimeout",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    }
}

错误码

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