开启或关闭消费者认证
更新时间：2026-09-22
该接口用于开启或关闭指定 Service 或 API 的消费者认证，并刷新所属实例的鉴权配置。
注意事项：
- 开启认证时必须选择
API_KEY或AK_SK；变更认证方式时，已有授权规则会同步改用新的认证方式。 - 关闭认证不会删除已有授权规则，重新开启后规则可继续生效。
请求结构
Plain Text
1POST /?action=UpdateConsumerAuthStatus HTTP/1.1
2Host: apigw-control.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "serviceId": serviceId,
7 "apiId": apiId,
8 "consumerAuthEnabled": consumerAuthEnabled,
9 "authorizationType": authorizationType
10}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| serviceId | String | 否 | RequestBody参数 | 服务 ID；与 apiId 二选一 |
| apiId | String | 否 | RequestBody参数 | API ID；与 serviceId 二选一（apiId 非空视为 Api 级） |
| consumerAuthEnabled | Boolean | 是 | RequestBody参数 | 是否开启消费者认证 |
| authorizationType | String | 否 | RequestBody参数 | 认证方式：API_KEY / AK_SK；开启认证时必填 |
返回头域
除公共头域，无其它特殊头域。
返回参数
无特殊返回参数。
错误码
| 错误码 | 错误描述 | HTTP状态码 | 中文解释 |
|---|---|---|---|
| MethodArgumentNotValidException | MethodArgumentNotValidException: consumerAuthEnabled must not be null | 400 | 必填参数缺失或格式不合法，具体见错误描述 |
| HttpMessageNotReadable | Http Message Not Readable: JSON parse error | 400 | 请求体不是合法 JSON，无法解析，请检查 JSON 语法和字段类型 |
| ResourcePermissionDeny | Resource permission deny. | 401 | 无权限访问指定资源，请确认使用正确的账号凭证且资源属于当前账号 |
| ServiceNotExist | Service not exist. | 404 | serviceId 对应的服务不存在、不属于当前账号或已删除 |
| ApiNotExist | Api not exist. | 404 | apiId 对应的路由不存在、不属于当前账号或已删除 |
| HttpMediaTypeException | HttpMediaTypeException: Content-Type 'text/plain' is not supported | 415 | 请求的 Content-Type 不受支持，请使用 application/json |
| DataPlaneSyncFailed | 配置已保存成功，但网关操作失败，请稍后重试或联系技术支持。 | 500 | 配置已写入控制面，但下发数据面失败，请稍后重试或联系技术支持 |
请求示例
Plain Text
1POST /?action=UpdateConsumerAuthStatus HTTP/1.1
2Host: apigw-control.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4
5{
6 "serviceId": "sg-a1b2c3d4",
7 "consumerAuthEnabled": true,
8 "authorizationType": "API_KEY"
9}返回示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Wed, 03 Dec 2014 06:42:19 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
6
7{}评价此篇文章