You need to enable JavaScript to run this app.
导航

更新 GTM 实例

最近更新时间2023.09.04 20:09:50

首次发布时间2023.08.21 14:31:37

API 说明

API 名称:UpdateGtm
API 域名:open.volcengineapi.com
API 描述:更新一个指定的 GTM 实例。

请求方法

POST

请求参数

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

参数名称
数据类型参数类型是否必选参数说明
ActionString查询参数API 的名称。该参数的取值是 UpdateGtm
VersionString查询参数API 的版本。该参数的取值是 2023-01-01
GtmIdString请求正文参数GTM 实例的 UUID。您可以通过 ListGtms API 获取 GtmId
TtlInteger请求正文参数GTM 实例中,调度域名解析记录缓存的过期时间。默认为 60 秒。
RemarkString请求正文参数GTM 实例的备注。UTF-8 格式。最大长度为 128 个 UTF-8 字符。如果您不设置该参数,该 GTM 实例的备注不会被更新。
AlarmIdString请求正文参数GTM 实例绑定的告警规则 ID。默认为空字符串,即该 GTM 实例不绑定告警规则。
PolicyTypeString请求正文参数GTM 实例中生效的调度策略。
  • geo:地理位置策略。根据用户的地理位置,将用户流量路由到距离用户最近的 IDC 机房的接入线路。
  • perf:性能最优策略。根据用户的地理位置,将用户流量路由到延迟最低的 IDC 机房的接入线路。

响应正文

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"
    }
}