{"componentChunkName":"component---src-templates-acg-portal-new-template-tsx","path":"/1moaxrbgi","result":{"data":{"markdownRemark":{"html":"

接口描述

\n

本接口用于在指定 AI 网关实例下创建消费者。消费者用于管理凭证、配额和授权路由；同一实例下消费者名称不可重复。

\n

注意事项

\n\n

请求结构

\n\n
\n
\n
\n Plain Text\n \n
\n
\n 
1POST /v1/aigw/{instanceId}/consumer HTTP/1.1\n2Host: aigw.bj.baidubce.com\n3X-Region: bj\n4Authorization: authorization string\n5Content-Type: application/json\n6\n7{\n8    "consumerName": "test-consumer",\n9    "authType": "KeyAuth",\n10    "useV2": true,\n11    "credential": {\n12        "name": "my-key",\n13        "generateMode": "auto",\n14        "inHeader": true,\n15        "inQuery": false,\n16        "keyNames": ["Authorization"]\n17    },\n18    "unlimitedQuota": false,\n19    "totalQuota": 5000,\n20    "quotaResetType": "daily",\n21    "unlimitedRequestQuota": false,\n22    "totalRequestQuota": 100,\n23    "requestQuotaResetType": "daily",\n24    "tags": [{"tagKey": "env", "tagValue": "prod"}]\n25}
\n
\n
\n
\n \n

请求头域

\n

除公共头域外，还需传入以下头域：

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
参数名称类型是否必选描述
X-RegionString是地域代码，如 bj、gz、su 等
\n

请求参数

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
参数名称类型是否必选参数位置描述
instanceIdString是URL参数AI 网关实例 ID
consumerNameString是RequestBody参数消费者名称，长度 2-64 个字符，同一实例下不可重复
descriptionString否RequestBody参数消费者描述，最多 255 个字符
authTypeString是RequestBody参数认证方式，当前仅支持 KeyAuth
routeNamesList<String>否RequestBody参数授权路由名称列表；为空时表示授权所有路由
useV2Boolean是RequestBody参数是否启用 2.0 凭证管理，必须为 true
credentialCredential否RequestBody参数凭证配置；不传则创建空凭证占位，后续可通过编辑接口添加
unlimitedQuotaBoolean是RequestBody参数是否不限 Token 配额；为 false 时 totalQuota 必填
totalQuotaInteger条件必选RequestBody参数Token 配额总量，unlimitedQuota=false 时必填且须 ≥ 0
quotaResetTypeString否RequestBody参数Token 配额重置周期，可选值：none/daily/weekly/monthly，默认 none
quotaResetDayInteger条件必选RequestBody参数每月重置日（1-31），quotaResetType=monthly 时必填
quotaResetWeekdayInteger条件必选RequestBody参数每周重置星期（0=周日，…，6=周六），quotaResetType=weekly 时必填
quotaResetHourInteger否RequestBody参数重置时刻小时（0-23，CST），默认 0
quotaResetMinuteInteger否RequestBody参数重置时刻分钟（0-59），默认 0
unlimitedRequestQuotaBoolean是RequestBody参数是否不限请求次数配额；为 false 时 totalRequestQuota 必填
totalRequestQuotaInteger条件必选RequestBody参数请求次数配额总量，unlimitedRequestQuota=false 时必填且须 > 0
requestQuotaResetTypeString否RequestBody参数请求次数配额重置周期，取值同 quotaResetType，默认 none
requestQuotaResetDayInteger条件必选RequestBody参数每月重置日（1-31），requestQuotaResetType=monthly 时必填
requestQuotaResetWeekdayInteger条件必选RequestBody参数每周重置星期（0=周日，…，6=周六），requestQuotaResetType=weekly 时必填
requestQuotaResetHourInteger否RequestBody参数重置时刻小时（0-23，CST），默认 0
requestQuotaResetMinuteInteger否RequestBody参数重置时刻分钟（0-59），默认 0
tagsList<Tag>条件必选RequestBody参数标签列表；srcProduct=agentos 时必须包含 userName 标签
\n

Credential 字段说明

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
参数名称类型是否必选描述
nameString否凭证名称，用于前端展示；不传时系统自动生成形如 {consumerName}-{consumerId}-{timestamp} 的唯一名称
descriptionString否凭证描述
generateModeString否生成方式，可选值：auto（自动生成）、custom（自定义），默认 auto
valueString条件必选自定义凭证明文值，generateMode=custom 时必填
inHeaderBoolean二选一是否通过 HTTP Header 传递，与 inQuery 不能同时为 true
inQueryBoolean二选一是否通过 HTTP Query 传递，与 inHeader 不能同时为 true
keyNamesList<String>是Header/Query 的 key 名列表，如 [\"Authorization\"]
\n

Tag 字段说明

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
参数名称类型是否必选描述
tagKeyString是标签键
tagValueString是标签值
\n

响应头域

\n

除公共头域外，无其它特殊头域。

\n

响应参数

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
参数名称类型描述
consumerIdString新创建消费者的 ID
credentialString若创建时生成凭证则返回凭证明文；无凭证创建时为空字符串
authVersionInteger认证版本号，固定为 2
\n

请求示例

\n\n
\n
\n
\n Plain Text\n \n
\n
\n 
1POST http://aigw.bj.baidubce.com/v1/aigw/i-a1b2c3d4/consumer\n2Host: aigw.bj.baidubce.com\n3X-Region: bj\n4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2026-04-23T04:17:29Z/3600/host;x-bce-date/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de\n5Content-Type: application/json\n6\n7{\n8    "consumerName": "test-consumer",\n9    "description": "测试用消费者",\n10    "authType": "KeyAuth",\n11    "routeNames": ["route-001", "route-002"],\n12    "useV2": true,\n13    "credential": {\n14        "name": "my-key",\n15        "generateMode": "auto",\n16        "inHeader": true,\n17        "inQuery": false,\n18        "keyNames": ["Authorization"]\n19    },\n20    "unlimitedQuota": false,\n21    "totalQuota": 5000,\n22    "quotaResetType": "daily",\n23    "quotaResetHour": 0,\n24    "quotaResetMinute": 0,\n25    "unlimitedRequestQuota": false,\n26    "totalRequestQuota": 100,\n27    "requestQuotaResetType": "daily",\n28    "requestQuotaResetHour": 0,\n29    "requestQuotaResetMinute": 0,\n30    "tags": [{"tagKey": "env", "tagValue": "prod"}]\n31}
\n
\n
\n
\n \n

响应示例

\n\n
\n
\n
\n Plain Text\n \n
\n
\n 
1HTTP/1.1 200 OK\n2Content-Type: application/json;charset=UTF-8\n3x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5\n4\n5{\n6    "consumerId": "cs-9d9b2f86ec8bde77",\n7    "credential": "Bearer 9d9b2f86-ec8bde77-444b-57ce9ce6e6b6",\n8    "authVersion": 2\n9}
\n
\n
\n
\n ","fields":{"slug":"1moaxrbgi","title":"创建消费者","date":"2026-04-24","extractedHeadings":[]},"headings":[{"value":"接口描述","depth":2},{"value":"注意事项","depth":2},{"value":"请求结构","depth":2},{"value":"请求头域","depth":2},{"value":"请求参数","depth":2},{"value":"Credential 字段说明","depth":3},{"value":"Tag 字段说明","depth":3},{"value":"响应头域","depth":2},{"value":"响应参数","depth":2},{"value":"请求示例","depth":2},{"value":"响应示例","depth":2}]}},"pageContext":{"isCreatedByStatefulCreatePages":false,"slug":"1moaxrbgi","prev":{"id":"qmoa01fmx","name":"服务域名","path":"qmoa01fmx","filePath":"API参考/服务域名.md","seo":null,"parentIds":["dmoa011tn"],"parents":[{"id":"dmoa011tn","documentId":"8aa3929e-d1b1-460a-a572-bdfb632ec326","name":"API参考","repoName":"AIGW","filePath":"API参考","disabled":false,"path":"dmoa011tn","lastMergeTime":null,"isApiDoc":null,"httpMethod":null,"seo":null,"sourceOrgName":null,"sourceRepoName":null,"sourceDocumentId":""}]},"next":{"id":"imoay8ngg","name":"查询消费者列表","path":"imoay8ngg","filePath":"API参考/消费者相关接口/查询消费者列表.md","seo":null,"parentIds":["dmoa011tn","Fmoax5m1d"],"parents":[{"id":"dmoa011tn","documentId":"8aa3929e-d1b1-460a-a572-bdfb632ec326","name":"API参考","repoName":"AIGW","filePath":"API参考","disabled":false,"path":"dmoa011tn","lastMergeTime":null,"isApiDoc":null,"httpMethod":null,"seo":null,"sourceOrgName":null,"sourceRepoName":null,"sourceDocumentId":""},{"id":"Fmoax5m1d","documentId":"d882bf3d-fedc-4a28-a9ac-093e4af394f0","name":"消费者相关接口","repoName":"AIGW","filePath":"API参考/消费者相关接口","disabled":false,"path":"Fmoax5m1d","lastMergeTime":null,"isApiDoc":null,"httpMethod":null,"seo":null,"sourceOrgName":null,"sourceRepoName":null,"sourceDocumentId":""}]},"parents":[{"id":"dmoa011tn","documentId":"8aa3929e-d1b1-460a-a572-bdfb632ec326","name":"API参考","repoName":"AIGW","filePath":"API参考","disabled":false,"path":"dmoa011tn","lastMergeTime":null,"isApiDoc":null,"httpMethod":null,"seo":null,"sourceOrgName":null,"sourceRepoName":null,"sourceDocumentId":""},{"id":"Fmoax5m1d","documentId":"d882bf3d-fedc-4a28-a9ac-093e4af394f0","name":"消费者相关接口","repoName":"AIGW","filePath":"API参考/消费者相关接口","disabled":false,"path":"Fmoax5m1d","lastMergeTime":null,"isApiDoc":null,"httpMethod":null,"seo":null,"sourceOrgName":null,"sourceRepoName":null,"sourceDocumentId":""}],"specificSeo":null}}}