切换主题
身份与应用
平台管理员创建应用、签发与撤销本地凭据；有效身份读取 /me，自身应用身份读取应用。默认入口由应用管理身份设置，并携带当前应用 revision。
POST /v1/apps
请求正文
Content-Type：application/json；正文必填。
类型：CreateApplication。—
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | Application |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 404 | application/json | Error |
| 409 | application/json | Error |
| 410 | application/json | Error |
| 412 | application/json | Error |
| 413 | application/json | Error |
| 429 | application/json | Error |
| 500 | application/json | Error |
| 502 | application/json | Error |
| 503 | application/json | Error |
GET /v1/apps
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | 数组：Application |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 404 | application/json | Error |
| 409 | application/json | Error |
| 410 | application/json | Error |
| 412 | application/json | Error |
| 413 | application/json | Error |
| 429 | application/json | Error |
| 500 | application/json | Error |
| 502 | application/json | Error |
| 503 | application/json | Error |
GET /v1/apps/
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | Application |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 404 | application/json | Error |
| 409 | application/json | Error |
| 410 | application/json | Error |
| 412 | application/json | Error |
| 413 | application/json | Error |
| 429 | application/json | Error |
| 500 | application/json | Error |
| 502 | application/json | Error |
| 503 | application/json | Error |
PUT /v1/apps/
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
| If-Match | header | 是 | string；— |
请求正文
Content-Type：application/json；正文必填。
| 字段 | 类型 | 本层必填 | 默认值与约束 |
|---|---|---|---|
| name | string | 否 | minLength: 1；maxLength: 128 |
| status | string | 否 | enum: ["DRAFT","ACTIVE","SUSPENDED","ARCHIVED"] |
| reason | string | 否 | maxLength: 512 |
| permissionProvider | BusinessProvider | 否 | — |
| contextProvider | ContextProvider | 否 | — |
| evaluationGate | EvaluationGate | 否 | — |
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | Application |
| 400 | application/json | Error |
| 403 | application/json | Error |
| 412 | application/json | Error |
POST /v1/apps/{app}/tokens
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
请求正文
Content-Type：application/json；正文必填。
类型：CreateToken。—
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | Token |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 404 | application/json | Error |
| 409 | application/json | Error |
| 410 | application/json | Error |
| 412 | application/json | Error |
| 413 | application/json | Error |
| 429 | application/json | Error |
| 500 | application/json | Error |
| 502 | application/json | Error |
| 503 | application/json | Error |
GET /v1/apps/{app}/tokens
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | 数组：Token |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 404 | application/json | Error |
| 409 | application/json | Error |
| 410 | application/json | Error |
| 412 | application/json | Error |
| 413 | application/json | Error |
| 429 | application/json | Error |
| 500 | application/json | Error |
| 502 | application/json | Error |
| 503 | application/json | Error |
DELETE /v1/apps/{app}/tokens/
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
| tokenId | path | 是 | string；— |
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | Token |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 404 | application/json | Error |
| 409 | application/json | Error |
| 410 | application/json | Error |
| 412 | application/json | Error |
| 413 | application/json | Error |
| 429 | application/json | Error |
| 500 | application/json | Error |
| 502 | application/json | Error |
| 503 | application/json | Error |
PUT /v1/apps/{app}/default-agent
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
| If-Match | header | 是 | string；— |
请求正文
Content-Type：application/json；正文必填。
类型：DefaultAgent。—
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | Application |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 404 | application/json | Error |
| 409 | application/json | Error |
| 410 | application/json | Error |
| 412 | application/json | Error |
| 413 | application/json | Error |
| 429 | application/json | Error |
| 500 | application/json | Error |
| 502 | application/json | Error |
| 503 | application/json | Error |
GET /v1/me
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | object |
| 其他错误 | application/json | Error |
GET /v1/apps/{app}/agent-entries/
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
| agentId | path | 是 | string；— |
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | Ref |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 404 | application/json | Error |
| 409 | application/json | Error |