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

文档中心

立即注册

导航

TrafficRoute DNS 套件

UpdateGtm-更新 GTM 实例

最近更新时间：2024.07.15 14:47:35首次发布时间：2023.08.21 14:31:37

更新一个 GTM 实例。

请求说明

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

请求参数

除了以下参数，您还需要对请求进行鉴权。

Query

名称	类型	是否必选	示例值	描述
Action	String	是	`UpdateGtm`	API 的名称。该参数的取值是 `UpdateGtm`。
Version	String	是	`2023-01-01`	API 的版本。该参数的取值是 `2023-01-01`。

Body

名称	类型	是否必选	示例值	描述
GtmId	String	是	`2a8f91c4-aa07-4ae4-9ebc-68750d611822`	GTM 实例的 UUID。您可以通过 ListGtms API 获取 `GtmId`。
Ttl	Integer	否	`60`	GTM 实例中，调度域名解析记录缓存的过期时间。默认为 60 秒。
Remark	String	否	`Remark`	GTM 实例的备注。UTF-8 格式。最大长度为 128 个 UTF-8 字符。如果您不设置该参数，该 GTM 实例的备注不会被更新。
AlarmId	String	否	`157284163494346****`	GTM 实例绑定的告警规则 ID。默认为空字符串，即该 GTM 实例不绑定告警规则。
PolicyType	String	否	`geo`	GTM 实例中生效的策略。 geo：基础路由。 perf：智能路由。

返回参数

ResponseMetadata 对象

参数名称	数据类型	参数说明
RequestId	String	标识本次请求的 ID。
Action	String	Action 查询参数的值。
Version	String	API 版本。
Service	String	服务类型。
Region	String	服务所在区域。

示例

请求示例

POST https://open.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"
    }
}

错误码

您可访问公共错误码，获取详细信息。