Skip to content
PATCH/v1/apikeys/{id}/status

启用或禁用 API Key

`status` 字段遵循当前代码实现:`0` 表示启用,`1` 表示禁用。

基础信息

鉴权Authorization: Bearer 管理 token
请求类型application/json
响应类型application/json

请求参数

Path

字段
类型
必填
位置
说明
id
string
path
API Key ID。
示例:"1001"

Body

字段
类型
必填
位置
说明
status
string
body
状态值:0 启用,1 禁用。
示例:"0"

请求示例

json
{
  "status": "0"
}

响应示例

json
{
  "code": 200,
  "msg": "操作成功",
  "data": null
}

错误码

HTTPcode说明
401unauthorized管理开放 API 鉴权失败。
400validation_error请求参数格式错误或取值不满足约束。
404not_found目标资源不存在或不属于当前商户。

在线调试

Playground · 浏览器直连网关

启用或禁用 API Key

修改 API Key 状态。

json
尚未发起请求。
bash
curl --location --request PATCH 'https://api.harnmodel.com/v1/apikeys/1001/status' \
  --header 'Authorization: Bearer mgmt-token-xxx' \
  --header 'Content-Type: application/json' \
  --data '{}'

多语言示例

bash
curl --location --request PATCH 'https://api.harnmodel.com/v1/apikeys/1001/status' \
  --header 'Authorization: Bearer mgmt-token-xxx' \
  --header 'Content-Type: application/json' \
  --data '{
    "status": "0"
  }'

千云开发者中心仅维护中文第一版文档;接口口径以当前后端实现为准。