查询状态页订阅者列表

查询已订阅状态页通知的用户列表。

GET /status-page/subscriber/list

查询状态页订阅者列表

cURL

curl --request GET \
  --url 'https://api.flashcat.cloud/status-page/subscriber/list?app_key='

import requests

url = "https://api.flashcat.cloud/status-page/subscriber/list?app_key="

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.flashcat.cloud/status-page/subscriber/list?app_key=', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.flashcat.cloud/status-page/subscriber/list?app_key=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.flashcat.cloud/status-page/subscriber/list?app_key="

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.flashcat.cloud/status-page/subscriber/list?app_key=")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.flashcat.cloud/status-page/subscriber/list?app_key=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

200

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "total": 2,
    "has_next_page": false,
    "items": [
      {
        "recipient": "[e-mail]",
        "method": "email",
        "components": [],
        "all": true,
        "locale": "zh-CN"
      },
      {
        "recipient": "[e-mail]",
        "method": "email",
        "components": [],
        "all": true,
        "locale": "en-US"
      }
    ]
  }
}

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "error": {
    "code": "InvalidParameter",
    "message": "The specified parameter is not valid."
  }
}

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "error": {
    "code": "Unauthorized",
    "message": "You are unauthorized."
  }
}

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "error": {
    "code": "RequestTooFrequently",
    "message": "Request too frequently."
  }
}

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "error": {
    "code": "InternalError",
    "message": "We encountered an internal error, and it has been reported. Please try again later."
  }
}

​

限制说明

项目	说明
速率限制	每个账户 1,000 次/分钟；50 次/秒
权限要求	无 —— 持有有效的 app_key 即可调用

授权

app_key · string · query · 必填

在 Flashduty 控制台 账户 → APP Key 中签发的 app_key。调用任何公开 API 时都必须携带。它等同于所属账户的身份凭证，请妥善保管。

查询参数

page_id · integer<int64> · 必填

Status page ID.

component_ids · string

Comma-separated component IDs to filter subscribers by.

p · integer<int64> · 默认值: 1

Page number (1-based).

必填范围: x >= 1

limit · integer<int64> · 默认值: 10

Page size (1-100).

必填范围: 1 <= x <= 100

响应

200

application/json

成功

成功响应结构。2xx 响应中 request_id 标识本次调用（同时出现在 Flashcat-Request-Id 响应头中），data 为接口业务 payload。失败响应使用不同结构，参见 ErrorResponse。

request_id · string · 必填

本次请求的唯一 ID，也会在 Flashcat-Request-Id 响应头中返回。反馈问题时请一并附上。

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data · object · 必填

状态页订阅者分页列表。

Show child attributes