跳转至

获取源组列表

1. 接口描述

接口请求路径:GET /prod-api/acdn/originsRest/getOriginGroupsList

getOriginGroupsList 用于查询指定海外 ACDN 分发下的源组(Origin Group)列表,包含故障转移条件与成员源。账号需具备 acdn:DescribeAllDistribution 权限。

Token 获取方式见 密钥鉴权

2. 输入参数

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

参数名称 必选 类型 描述
distributionId Long Query 参数。分发主键 ID。示例值:39
searchValue String Query 参数。搜索关键字(入参字段;当前服务端实现未用于过滤)

3. 输出参数

参数名称 类型 描述
code Integer 状态码。示例值:200
msg String 提示信息。示例值:操作成功
data Object 源组数据
data.OriginGroups OriginGroups 源组集合

4. 示例

示例1 查询源组列表

输入示例

GET /prod-api/acdn/originsRest/getOriginGroupsList?distributionId=39

代码调用

请将 {登录域名}token 替换为实际值。

curl -X GET 'https://{登录域名}/prod-api/acdn/originsRest/getOriginGroupsList?distributionId=39' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.xxxxxx'
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class GetOriginGroupsListTest {

    public static void main(String[] args) throws Exception {
        String token = "eyJhbGciOiJIUzUxMiJ9.xxxxxx";

        URIBuilder uriBuilder = new URIBuilder("https://{登录域名}/prod-api/acdn/originsRest/getOriginGroupsList");
        uriBuilder.addParameter("distributionId", "39");

        try (CloseableHttpClient httpClient = HttpClients.createDefault()) {
            HttpGet httpGet = new HttpGet(uriBuilder.build());
            httpGet.setHeader("Authorization", "Bearer " + token);

            try (CloseableHttpResponse response = httpClient.execute(httpGet)) {
                int statusCode = response.getStatusLine().getStatusCode();
                String body = EntityUtils.toString(response.getEntity(), "UTF-8");
                System.out.println("Status Code: " + statusCode);
                System.out.println("Body: " + body);
            }
        }
    }
}
package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    token := "eyJhbGciOiJIUzUxMiJ9.xxxxxx"

    u, err := url.Parse("https://{登录域名}/prod-api/acdn/originsRest/getOriginGroupsList")
    if err != nil {
        panic(err)
    }
    q := u.Query()
    q.Set("distributionId", "39")
    u.RawQuery = q.Encode()

    req, err := http.NewRequest(http.MethodGet, u.String(), nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer "+token)

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println("Status Code:", resp.StatusCode)
    fmt.Println("Body:", string(body))
}

输出示例

{
  "msg": "操作成功",
  "code": 200,
  "data": {
    "OriginGroups": {
      "quantity": 1,
      "items": [
        {
          "id": "og-demo",
          "failoverCriteria": {
            "statusCodes": {
              "quantity": 1,
              "items": [403]
            }
          },
          "members": {
            "quantity": 2,
            "items": [
              {"originId": "origin-a.example.com"},
              {"originId": "origin-b.example.com"}
            ]
          }
        }
      ]
    }
  }
}

5. 错误码

HTTP 状态码 / 业务提示 描述
200 成功
401 未鉴权或 Token 无效
403 无权限
id不能为空 未传入 distributionId

6. 数据模型

OriginGroups

源组集合。

参数名称 类型 描述
quantity Integer 源组数量。示例值:1
items [OriginGroup] 源组列表

OriginGroup

单个源组。

参数名称 类型 描述
id String 源组名称。示例值:og-demo
failoverCriteria Object 故障转移条件,含 statusCodes
failoverCriteria.statusCodes.quantity Integer 状态码数量。示例值:1
failoverCriteria.statusCodes.items Array of Integer 状态码。取值:400(请求错误)、403(禁止访问)、404(未找到)、416(范围无法满足)、502(无效网关)、503(服务不可用)、504(网关超时)。示例值:[403]
members Object 源组成员,含 quantityitems
members.items[].originId String 成员源 ID。示例值:origin-a.example.com