Management Key

Lấy một API key

Lấy một API key trong phạm vi mà người gọi được xem. Với Management Key của tổ chức, ID phải thuộc chính tổ chức của key đó; key cá nhân của chủ sở hữu và key của tổ chức khác đều trả về 404 mà không tiết lộ chúng có tồn tại hay không. Phản hồi có dạng { data: <key>, key: <key> }, hai trường chứa cùng một object. <key> gồm limit, limit_remaining, limit_reset, usage, usage_daily/weekly/monthly, requests, requests_daily/weekly/monthly và usage_scope: key. Số liệu sử dụng khớp với GET /v1/key khi gọi bằng key đó. limit_remaining bằng hạn mức trừ chi phí của key trong kỳ đặt lại; nếu không có hạn mức riêng thì là số dư tài khoản hoặc tổ chức mà key sử dụng. Không trả về secret thô.

GET/v1/keys/:id

Xác thực

Authorizationbắt buộc

string · header

API key dưới dạng bearer token trong header Authorization.

Tham số đường dẫn

idbắt buộc

string

ID của API key cần lấy.

GET /v1/keys/:id

1
2
curl https://api.bazaarlink.ai/v1/keys/key_demo_01 \
  -H "Authorization: Bearer $BAZAARLINK_MANAGEMENT_KEY"

Ví dụ phản hồi

Thành công. data và key chứa cùng object key, usage_scope luôn là key.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
  "data": {
    "id": "key_demo_01",
    "name": "worker-a",
    "keyPrefix": "demo_",
    "keySuffix": "01",
    "enabled": true,
    "keyType": "standard",
    "limit": 10,
    "limit_remaining": 7.88,
    "limit_reset": "day",
    "usage": 24.41,
    "usage_daily": 2.12,
    "usage_weekly": 5.64,
    "usage_monthly": 9.37,
    "requests": 314,
    "requests_daily": 18,
    "requests_weekly": 61,
    "requests_monthly": 205,
    "usage_scope": "key",
    "spendLimitUsd": 10,
    "spendLimitPeriod": "day",
    "organizationId": "org_demo_01",
    "expiresAt": null
  },
  "key": {
    "id": "key_demo_01",
    "name": "worker-a",
    "keyPrefix": "demo_",
    "keySuffix": "01",
    "enabled": true,
    "keyType": "standard",
    "limit": 10,
    "limit_remaining": 7.88,
    "limit_reset": "day",
    "usage": 24.41,
    "usage_daily": 2.12,
    "usage_weekly": 5.64,
    "usage_monthly": 9.37,
    "requests": 314,
    "requests_daily": 18,
    "requests_weekly": 61,
    "requests_monthly": 205,
    "usage_scope": "key",
    "spendLimitUsd": 10,
    "spendLimitPeriod": "day",
    "organizationId": "org_demo_01",
    "expiresAt": null
  }
}