You need to enable JavaScript to run this app.
导航
TrafficRoute DNS 套件
  • 文档首页
    • /
  • TrafficRoute DNS 套件

获取 GTM 实例信息

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

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

我的收藏

API 说明

API 名称：GetGtm。
API 域名：open.volcengineapi.com。
API 描述：获取指定 GTM 实例的信息。

请求方法

POST

请求参数

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

参数名称
数据类型参数类型是否必选参数说明
ActionString查询参数是API 的名称。该参数的取值是 GetGtm。
VersionString查询参数是API 的版本。该参数的取值是 2023-01-01。
GtmIdString请求正文参数是GTM 实例的 UUID。您可以通过 ListGtms API 获取 GtmId。

响应正文

ResponseMetadata 对象

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

Result 对象

参数名称
数据类型
参数说明
GtmId
String
GTM 实例的 UUID。
Domain
String
GTM 实例的域名。
Cname
String
GTM 实例的调度域名。
PolicyType
String
调度策略类型。该参数取值为：
  • geo：地理位置策略。
  • perf：性能最优策略。
Ttl
Integer
解析记录的过期时间。单位为秒。
Remark
String
GTM 实例的备注信息。
AlarmId
String
该 GTM 实例所绑定的告警规则 ID。
AccessMode
String
GTM 实例的接入方式。
  • cname：云调度 GTM 根据您的域名自动生成调度域名。根据您在云调度 GTM 中的流量调度配置，云调度 GTM 将该调度域名解析成目标地址的 IP 或域名。您需要在您的 DNS 服务商处创建一条 CNAME 记录，然后将您的域名指向该调度域名。
  • domain：将您的域名解析成目标地址的 IP 或域名。只有您的域名的 DNS 服务商是云解析 DNS 时，您才能使用该接入方式。
CreateTime
String
GTM 实例的创建时间。精确到毫秒。格式符合 ISO 8601 标准。
UpdateTime
String
GTM 实例最近的更改时间。精确到毫秒。格式符合 ISO 8601 标准。
State
String
GTM 实例状态。该参数值为：
  • running：GTM 实例启动了自动流量路由。
  • editing：GTM 实例停止了自动流量路由。
Owner
String
创建该 GTM 实例的用户的火山引擎账号。
LastOperator
String
最后一个操作该 GTM 实例的用户的火山引擎账号。
SpecName
String
GTM 实例的功能版本。

示例

请求示例

POST https://open.volcengineapi.com?Action=GetGtm&Version=2023-01-01&id=b46cf3dc-10e5-4847-8e32-e5c7696eebd0

响应示例

{
    "ResponseMetadata": {
        "RequestId": "202308151244209978209E06C3786B29A7",
        "Action": "GetGtm",
        "Version": "2023-01-01",
        "Service": "gtm",
        "Region": "cn-north-1"
    },
    "Result": {
        "GtmId": "2a8f91c4-aa07-4ae4-9ebc-68750d611822",
        "Domain": "example.com",
        "Cname": "example.com.gtm.volcdns-boe.com",
        "PolicyType": "geo",
        "Ttl": 60,
        "Remark": "",
        "AlarmId": "",
        "AccessMode": "cname",
        "CreateTime": "2023-07-26T10:32:33.152Z",
        "UpdateTime": "2023-08-07T04:48:55.508Z",
        "State": "editing",
        "Owner": "21xxxx11",
        "LastOperator": "224512",
        "SpecName": "旗舰版"
    }
}