版本 2.4.7.20261116085428 · 最新
套餐目录 package-catalog
客户可购买的套餐、分组与扩展包目录。
点击任一接口,右侧显示对应的调用示例。
套餐鉴权: 用户1 个接口
鉴权
请求头带 X-API-Key(在「API 密钥」页开通,密钥只在开通时显示一次);也可用登录得到的 Authorization: Bearer 令牌。
X-API-Key
鉴权失败回 401;无权回 403(code 为 insufficient_scope 等)。
约定
分页参数 page(从 1 起)、page_size;排序 sort=字段 或 -字段。
时间一律 RFC 3339(UTC);金额单位为分。
写操作成功回 200/201/204;重复提交按资源唯一键回 409。
套餐目录对象
| 字段 | 类型 | 说明 |
|---|---|---|
feature_states | PackageFeatureStates | 平台此刻各套餐付费项是否开通(授权状态不是未开通或已降级);false 的项套餐里含了也暂不生效。 |
groups | PackageGroup[] | 套餐分组。 |
packages | Package[] | 在售的基础套餐。 |
storefront | PackageStorefront | 购买页设置(系统配置 plan.storefront,经 GET/PUT /configs/plan.storefront 读写,PUT 带 expected_updated_at 防并发覆盖)。 |
upgrades | PackageUpgrade[] | 在售的扩展包。 |
返回与错误
成功直接回资源 JSON(HTTP 2xx);失败回 application/problem+json(code、detail,校验失败带 errors);列表为 items + total。
成功
{
"id": 1,
"name": "example"
}列表
{
"items": [
{
"id": 1
}
],
"page": 1,
"page_size": 20,
"total": 1
}失败
{
"code": "validation_failed",
"detail": "请求参数不合法",
"errors": [
{
"code": "required",
"field": "/name",
"message": "name 必填"
}
],
"request_id": "0123456789abcdef",
"status": 422,
"title": "Unprocessable Entity",
"type": "about:blank"
}