You need to enable JavaScript to run this app.
文档中心
TrafficRoute DNS 套件

TrafficRoute DNS 套件

请输入
  • 文档首页
    • TrafficRoute DNS 套件API 参考GTM 实例管理GetGtm - 获取 GTM 实例信息
复制全文
下载 pdf
我的收藏
GTM 实例管理
GetGtm - 获取 GTM 实例信息
复制全文
下载 pdf
我的收藏
GetGtm - 获取 GTM 实例信息
获取指定 GTM 实例的信息。​
请求说明​
  • 请求方式：POST​
  • 请求地址：https://gtm.volcengineapi.com/?Action=GetGtm&Version=2023-01-01​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
​
请求参数​
除了以下参数，您还需要 对请求进行鉴权。​
Action string 必选 示例值：GetGtm​
要执行的操作，取值：GetGtm。​
​
Version string 必选 示例值：2023-01-01​
API的版本，取值：2023-01-01。​
​
GtmId string 必选 示例值：2a8f91c4-aa07-4ae4-9ebc-68750d611822​
GTM 实例的 UUID。您可以通过 ListGtms API 获取 GtmId。​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
UpdateTime string 示例值：2023-07-26T10:32:33.152Z​
GTM 实例最近的更改时间。精确到毫秒。格式符合 ISO 8601 标准。​
​
ZoneType string 示例值：无​
该参数无实际意义。您可以忽略该参数。​
​
ProjectName string 示例值：default​
GTM 实例所属的项目名称。​
​
CreateTime string 示例值：2023-07-26T10:32:33.152Z​
GTM 实例的创建时间。精确到毫秒。格式符合 ISO 8601 标准。​
​
GtmId string 示例值：2a8f91c4-aa07-4ae4-9ebc-68750d611822​
GTM 实例的 UUID。​
​
Domain string 示例值：example.com​
GTM 实例的域名。​
​
Cname string 示例值：example.com.gtm.example.com​
GTM 实例的调度域名。​
​
PolicyType string 示例值：perf​
调度策略类型。该参数取值为：​
  • geo：基础路由策略。​
  • perf：智能路由策略。​
​
Ttl integer 示例值：600​
解析记录的过期时间。单位为秒。​
​
Remark string 示例值：remark​
GTM 实例的备注信息。​
​
AlarmId string 示例值：1654778652274982912​
GTM 实例所绑定的告警规则 ID。​
​
AddressType string 示例值：ip​
GTM 实例所包含的 IP 地址的类型。​
  • ip：IP 地址。​
  • domain：域名。​
​
AccessMode string 示例值：cname​
GTM 实例的接入方式。​
  • cname：云调度 GTM 根据您的域名自动生成调度域名。根据您在云调度 GTM 中的流量调度配置，云调度 GTM 将该调度域名解析成目标地址的 IP 或域名。您需要在您的 DNS 服务商处创建一条 CNAME 记录，然后将您的域名指向该调度域名。​
  • domain：将您的域名解析成目标地址的 IP 或域名。只有您的域名的 DNS 服务商是云解析 DNS 时，您才能使用该接入方式。​
​
CreatedTime string 示例值：2023-07-26T10:32:33.152Z​
GTM 实例的创建时间。精确到毫秒。格式符合 ISO 8601 标准。​
​
UpdatedTime string 示例值：2023-07-26T10:32:33.152Z​
GTM 实例最近的更改时间。精确到毫秒。格式符合 ISO 8601 标准。​
​
State string 示例值：init​
表示 GTM 实例当前的生命周期状态。​
取值说明：​
  • init：表示 GTM 实例已成功创建，但尚未进行任何配置。​
  • configuring_address：表示已完成 GTM 的基础规则配置，但尚未完成目标地址配置。​
  • editing：表示基础配置与目标地址均已配置完成，但实例尚未启用。​
  • running：表示实例已正式启用。​
​
Owner string 示例值：21xxxxx0​
创建该 GTM 实例的用户的火山引擎账号。​
​
LastOperator string 示例值：21xxxxx0​
最后一个操作该 GTM 实例的用户的火山引擎账号。​
​
SpecName string 示例值：standard​
GTM 实例的功能版本。​
  • ultimate：旗舰版​
  • standard：标准版​
​
​
​
请求示例​
​
POST /?Action=GetGtm&Version=2023-01-01&GtmId=2a8f91c4-aa07-4ae4-9ebc-68750d611822 HTTP/1.1​
Host: gtm.volcengineapi.com​
Content-Type: application/json; charset=UTF-8​
X-Date: 20260305T030559Z​
X-Content-Sha256: 287e874e******d653b44d21e​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260305/cn-beijing/gtm/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
{}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20260305110606202096091229E90C38",​
"Action": "GetGtm",​
"Version": "2023-01-01",​
"Service": "gtm",​
"Region": "cn-beijing"​
},​
"Result": {​
"UpdateTime": "2023-07-26T10:32:33.152Z",​
"ZoneType": "无",​
"ProjectName": "default",​
"CreateTime": "2023-07-26T10:32:33.152Z",​
"GtmId": "2a8f91c4-aa07-4ae4-9ebc-68750d611822",​
"Domain": "example.com",​
"Cname": "example.com.gtm.example.com",​
"PolicyType": "perf",​
"Ttl": 600,​
"Remark": "remark",​
"AlarmId": "1654778652274982912",​
"AddressType": "ip",​
"AccessMode": "cname",​
"CreatedTime": "2023-07-26T10:32:33.152Z",​
"UpdatedTime": "2023-07-26T10:32:33.152Z",​
"State": "init",​
"Owner": "21xxxxx0",​
"LastOperator": "21xxxxx0",​
"SpecName": "standard"​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
504​
internal error​
内部错误​
内部错误​
​
​
最近更新时间：2026.03.05 11:26:31
这个页面对您有帮助吗？
有用
有用
无用
无用