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 名称：ListGtms。
API 域名：open.volcengineapi.com。
API 描述：获取 GTM 实例列表。

请求方法

POST

请求参数

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

参数名称
数据类型参数类型是否必选参数说明
ActionString查询参数是API 的名称。该参数的取值是 ListGtms。
VersionString查询参数是API 的版本。该参数的取值是 2023-01-01。

Domain

String

查询参数

否

GTM 实例的域名，例如 www.volcengine.com。

默认为空值，即该参数不作为查询条件。

Cname

String

查询参数

否

GTM 实例的调度域名。

默认为空值，即该参数不作为查询条件。

State

String

查询参数

否

GTM 实例的状态。包括以下状态：

  • running：GTM 实例正在运行。
  • editing：GTM 实例处于停止状态。

默认为空值，即该参数不作为查询条件。

Remark

String

查询参数

否

GTM 实例的备注。

默认为空值，即该参数不作为查询条件。

SearchModeString查询参数否查询模式。包括以下模式：
  • like：（默认）模糊查询。
  • exact：精确查询。
PageNumberInteger查询参数否页码。默认为 1。页数由获取的 GTM 实例总数和 PageSize 确定。

PageSize

Integer

查询参数

否

每页包含的 GTM 实例的数量。默认为 50。
控制台会将获取的 GTM 实例进行分页显示。页数由获取的 GTM 实例总数和 PageSize 确定。

SortOrderString查询参数否GTM 实例列表的排列顺序。
  • asc：升序排序。
  • desc：（默认）降序排序。
SortByString查询参数否用于排序的值。
  • Domain：GTM 实例的域名。
  • Cname：GTM 实例的调度域名。
  • State：GTM 实例的状态。
  • Remark：GTM 实例的备注。
  • UpdateTime：（默认）GTM 实例的更新时间。
  • CreateTime：GTM 实例的创建时间。

响应正文

ResponseMetadata 对象

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

Result 对象

参数名称
数据类型
参数说明
TotalCount
Integer
GTM 实例的总数。
PageNumber
Integer
分页的页码。
PageSize
Integer
每个分页的 GTM 实例数量。
Data
Array of Objects
GTM 实例列表。

示例

请求示例

POST https://open.volcengineapi.com?Action=ListGtms&Version=2023-01-01&PageNumber=1&PageSize=1

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20230815121040FA867C5274B04F71EA82",
        "Action": "ListGtms",
        "Version": "2023-01-01",
        "Service": "gtm",
        "Region": "cn-north-1"
    },
    "Result": {
        "TotalCount": 21,
        "PageNumber": 1,
        "PageSize": 2,
        "Data": [
            {
                "GtmId": "2a8f91c4-aa07-4ae4-9ebc-68750d611822",
                "Domain": "example.com",
                "Cname": "example.com.gtm.volcdns.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": "2100042011",
                "LastOperator": "224512",
                "SpecName": "旗舰版"
            },
            {
                "GtmId": "5c7f5265-ca0f-4a60-bcd6-c4db7fcc4a95",
                "Domain": "biz04.example.com",
                "Cname": "biz04.example.com.gtm.volcdns.com",
                "PolicyType": "perf",
                "Ttl": 600,
                "Remark": "",
                "AlarmId": "1654778652274982912",
                "AccessMode": "cname",
                "CreateTime": "2023-04-04T11:58:32.676Z",
                "UpdateTime": "2023-07-27T12:46:55.237Z",
                "State": "editing",
                "Owner": "2100042011",
                "LastOperator": "2100042011",
                "SpecName": "旗舰版"
            }
        ]
    }
}