API 中心
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > API 中心 > 边缘安全加速平台 EO > 负载均衡相关接口 > 获取源站组列表

获取源站组列表

最近更新时间：2024-04-19 15:23:41

我的收藏

本页目录：

1. 接口描述

接口请求域名： teo.tencentcloudapi.com 。

获取源站组列表

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeOriginGroup。
Version 是 String 公共参数，本接口取值：2022-09-01。
Region 否 String 公共参数，此参数为可选参数。
ZoneId 否 String 站点ID，此参数必填。
Offset 否 Integer 分页查询偏移量，不填默认为0。
Limit 否 Integer 分页查询限制数目，不填默认为20，取值：1-1000。
Filters.N 否 Array of AdvancedFilter 过滤条件，Filters.Values的上限为20。详细的过滤条件如下：
  • origin-group-id
       按照【源站组ID】进行过滤。源站组ID形如：origin-2ccgtb24-7dc5-46s2-9r3e-95825d53dwe3a
       模糊查询：不支持
  • origin-group-name
       按照【源站组名称】进行过滤
       模糊查询：支持。使用模糊查询时，仅支持填写一个源站组名称
    		•

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 记录总数。
    OriginGroups Array of OriginGroup 源站组信息。
    RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 获取源站组列表

    获取指定源站组ID的源站组列表

    输入示例

    POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeOriginGroup
<公共请求参数>

{
    "Filters": [
        {
            "Name": "origin-group-id",
            "Values": [
                "origin-057c4d82-383c-11ee-8888-525400682e90"
            ]
        }
    ]
}

    输出示例

    {
    "Response": {
        "OriginGroups": [
            {
                "CreateTime": "2023-08-11T19:41:33Z",
                "GroupId": "origin-057c4d82-383c-11ee-8888-525400682e90",
                "HostHeader": "",
                "Name": "test_ruichaolin",
                "Records": [
                    {
                        "Private": false,
                        "PrivateParameters": [],
                        "Record": "4.4.4.4",
                        "RecordId": "record-3492ee3b-383c-11ee-8888-525400682e90",
                        "Type": "IP_DOMAIN",
                        "Weight": 40
                    }
                ],
                "References": [],
                "Type": "HTTP",
                "UpdateTime": "2023-08-11T19:41:33Z"
            }
        ],
        "RequestId": "a2e38df8-5800-4495-bd61-b6761b070d50",
        "TotalCount": 1
    }
}

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

    错误码 描述
    UnauthorizedOperation.CamUnauthorized Cam 未授权。
    UnauthorizedOperation.NoPermission 子账户没有操作权限，请添加权限后继续操作。
    UnauthorizedOperation.Unknown 后端服务器发生未知错误。
    中国站