TrafficRoute DNS 套件
TrafficRoute DNS 套件
云调度
请输入
- 文档首页
TrafficRoute DNS 套件API 参考GTM 实例管理ListGtms - 获取 GTM 实例列表
复制全文
下载 pdfListGtms - 获取 GTM 实例列表
文档反馈
问问助手获取 GTM 实例列表。
请求说明
- 请求方式：POST
- 请求地址：https://gtm.volcengineapi.com/?Action=ListGtms&Version=2023-01-01
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Action string 必选 示例值：ListGtms
要执行的操作，取值：ListGtms。
Version string 必选 示例值：2023-01-01
API的版本，取值：2023-01-01。
Domain string 可选 示例值：www.example.com
GTM 实例的域名，例如 www.example.com。默认为空值，即该参数不作为查询条件。
Cname string 可选 示例值：www.example.com.gtm.example.com
GTM 实例的调度域名。默认为空值，即该参数不作为查询条件。
Remark string 可选 示例值：remark
GTM 实例的备注。默认为空值，即该参数不作为查询条件。
SpecName string 可选 示例值：ultimate
GTM 实例的功能版本。
- ultimate：旗舰版
- standard：标准版
SearchMode string 可选 示例值：exact
查询模式。包括以下模式：
- like：（默认）模糊查询。
- exact：精确查询。
ProjectName string 可选 示例值：default
GTM 实例所属的项目名称。
TagFilters object[] 可选 示例值：TagFilters.1={"Key":"k1","Values":["v1", "v2"]}&TagFilters.2={"Key":"k2","Values":["v1", "v2"]}
GTM 实例的标签。您需要指定：
- N：表示 TagFilters 的序号，取值范围：1～10。N 应按照从小到大的顺序，且必须为连续的数字。
- 标签键：例如 "Key":"k1"。如果您指定多个标签键，云调度 GTM 会查询同时包含所有指定标签键的 GTM 实例。
- 标签值：例如 Values":["v1", "v2"]。标签值数组的长度取值范围为 1～3。
您可不传入 Values，表示查询时 Values 不作为查询条件。如果您把仅包含空字符串的数组传入 Values ，云调度 GTM 会查询 Values 为空的标签。如果一个 Values 包含多个值，这些值之间的关系为逻辑或（OR）。
Key string 必选 示例值：key
标签的键。
Values string[] 可选 示例值：["value1", "value2"]
标签的值列表。
PageNumber integer 可选 示例值：1
页码。默认为 1。页数由获取的 GTM 实例总数和 PageSize 确定。
PageSize integer 可选 示例值：50
每页包含的 GTM 实例的数量。默认为 50。
云调度 GTM 会将获取的 GTM 实例进行分页显示。页数由获取的 GTM 实例总数和 PageSize 确定。
SortOrder string 可选 示例值：asc
GTM 实例列表的排列顺序。
- asc：升序排序。
- desc：（默认）降序排序。
SortBy string 可选 示例值：Domain
用于排序的值。
- Domain：GTM 实例的域名。
- Cname：GTM 实例的调度域名。
- State：GTM 实例的状态。
- Remark：GTM 实例的备注。
- UpdateTime：（默认）GTM 实例的更新时间。
- CreateTime：GTM 实例的创建时间。
返回参数
TotalCount integer 示例值：10
GTM 实例的总数。
PageNumber integer 示例值：1
分页的页码。
PageSize integer 示例值：10
每个分页的 GTM 实例数量。
Data object[] 示例值：无
GTM 实例列表。
GtmId string 示例值：2a8f91c4-aa07-4ae4-9ebc-68750d611822
GTM 实例的 UUID。
Domain string 示例值：www.example.com
GTM 实例的域名。
Cname string 示例值：www.example.com.abc.gtm.com
GTM 实例的调度域名。
ProjectName string 示例值：default
GTM 实例所属的项目名称。
ResourceTags object[] 示例值：无
GTM 实例所关联的标签。
Key string 示例值：key
标签的键。
Value string 示例值：value
标签的值。
PolicyType string 示例值：geo
调度策略类型。该参数取值为：
- 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 时，您才能使用该接入方式。
CreateTime string 示例值：2023-07-26T10:32:33.152Z
GTM 实例的创建时间。精确到毫秒。格式符合 ISO 8601 标准。
UpdateTime 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 示例值：ultimate
GTM 实例的功能版本。
- ultimate：旗舰版
- standard：标准版
请求示例
POST /?Action=ListGtms&Version=2023-01-01 HTTP/1.1
Host: gtm.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20260305T031231Z
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
{
"Domain": "www.example.com",
"Cname": "www.example.com.gtm.example.com",
"Remark": "remark",
"SpecName": "ultimate",
"SearchMode": "exact",
"ProjectName": "default",
"TagFilters": [
{
"Key": "key",
"Values": [
"["value1", "value2"]"
]
}
],
"PageNumber": 1,
"PageSize": 50,
"SortOrder": "asc",
"SortBy": "Domain"
}
返回示例
{
"ResponseMetadata": {
"RequestId": "20260305110953245143186005E74B78",
"Action": "ListGtms",
"Version": "2023-01-01",
"Service": "gtm",
"Region": "cn-beijing"
},
"Result": {
"TotalCount": 10,
"PageNumber": 1,
"PageSize": 10,
"Data": [
{
"GtmId": "2a8f91c4-aa07-4ae4-9ebc-68750d611822",
"Domain": "www.example.com",
"Cname": "www.example.com.abc.gtm.com",
"ProjectName": "default",
"ResourceTags": [
{
"Key": "key",
"Value": "value"
}
],
"PolicyType": "geo",
"Ttl": 600,
"Remark": "remark",
"AlarmId": "1654778652274982912",
"AddressType": "ip",
"AccessMode": "cname",
"CreateTime": "2023-07-26T10:32:33.152Z",
"UpdateTime": "2023-07-26T10:32:33.152Z",
"State": "init",
"Owner": "21xxxxx0",
"LastOperator": "21xxxxx0",
"SpecName": "ultimate"
}
]
}
}
错误码
最近更新时间：2026.03.05 11:26:31
这个页面对您有帮助吗？
有用
有用
无用
无用