UpdateGtm - 更新GTM实例--TrafficRoute DNS 套件-火山引擎

文档中心

立即注册

TrafficRoute DNS 套件

请输入

GTM 实例管理

UpdateGtm - 更新GTM实例

更新一个 GTM 实例。

请求说明

请求方式：POST
请求地址：https://gtm.volcengineapi.com/?Action=UpdateGtm&Version=2023-01-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	UpdateGtm	要执行的操作，取值：UpdateGtm。
Version	String	是	2023-01-01	API的版本，取值：2023-01-01。
GtmId	String	是	2a8f91c4-aa07-4ae4-9ebc-68750d611822	GTM 实例的 UUID。您可以通过 ListGtms API 获取 `GtmId`。
PolicyType	String	否	geo	GTM 实例中生效的策略。 geo：基础路由。 perf：智能路由。
Ttl	Integer	否	60	GTM 实例中，调度域名解析记录缓存的过期时间。
Remark	String	否	Remark	GTM 实例的备注。UTF-8 格式。最大长度为 128 个 UTF-8 字符。
AlarmId	String	否	157284163494346	GTM 实例关联的告警规则 ID。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

POST https://gtm.volcengineapi.com/?Action=UpdateGtm&Version=2023-01-01

{
	"GtmId":"2a8f91c4-aa07-4ae4-9ebc-68750d611822",
  "Remark": "test"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230817180124A911D7D31AC9914A50DE",
        "Action": "UpdateGtm",
        "Version": "2023-01-01",
        "Service": "GTM",
        "Region": "cn-north-1"
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
504	504	内部错误

最近更新时间：2025.07.21 11:55:22

这个页面对您有帮助吗？

有用

无用