创建消费者
更新时间:2026-08-17
接口描述
创建指定 AI 网关实例下的消费者。
OpenAPI Explorer
去调试
您可以在 OpenAPI Explorer 中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer 可以自动生成 SDK 代码示例。
请求结构
Plain Text
1POST /v1/aigw/{instanceId}/consumer HTTP/1.1
2Host: aigw.bj.baidubce.com
3X-Region: bj
4Authorization: authorization string
5Content-Type: application/json
请求头域
必须传入 X-Region。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | URL参数 | AI 网关实例 ID |
| consumerName | String | 是 | RequestBody参数 | 消费者名称 |
| description | String | 否 | RequestBody参数 | 描述 |
| authType | String | 是 | RequestBody参数 | KeyAuth 或 JWT |
| credentialType | String | 是 | RequestBody参数 | LOCAL 或 IAM |
| routeNames | List |
否 | RequestBody参数 | 关联路由名称列表 |
| tags | List |
否 | RequestBody参数 | 消费者标签 |
| credential | ConsumerCredentialSpec | 否 | RequestBody参数 | 本地凭证配置 |
| iamCredential | IAMCredentialSpec | 否 | RequestBody参数 | IAM 凭证配置 |
返回状态码
成功返回 200;参数错误返回 400;资源不存在返回 404。
返回头域
除公共头域外,无其他特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| success | Boolean | 是否成功 |
| status | Integer | HTTP 状态码 |
| consumerId | String | 消费者 ID |
| credential | String | 创建后的凭证(敏感值) |
| credentials | List |
多凭证详情 |
| credentialType | String | 凭证类型 |
请求示例
Plain Text
1POST https://aigw.bj.baidubce.com/v1/aigw/aigw-example/consumer HTTP/1.1
2X-Region: bj
3Authorization: authorization string
4Content-Type: application/json
5
6{"consumerName":"consumer-demo","authType":"KeyAuth","credentialType":"LOCAL"}
返回示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3
4{"success":true,"status":200,"consumerId":"consumer-id"}
评价此篇文章
