使用CreateConsumer API创建消费者-API网关-阿里云-API 网关(API Gateway)-阿里云帮助中心

创建消费者。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

apig:CreateConsumer

create

*全部资源

*

无

请求语法

POST /v1/consumers HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
body	object	否	请求 Body。
name	string	否	消费者名称。	test
description	string	否	消费者描述。	consumer for test
jwtIdentityConfig	JwtIdentityConfig	否	JWT 身份配置。
akSkIdentityConfigs	array	否	AK/SK 身份配置列表。
	AkSkIdentityConfig	否	AK/SK 身份配置。
apikeyIdentityConfig	ApiKeyIdentityConfig	否	APIKEY 鉴权方式身份配置。
enable	boolean	否	是否启用。	false
gatewayType	string	否	网关类型。 API：云原生 API 网关的消费者 AI：AI 网关的消费者	API

返回参数

名称	类型	描述	示例值
	object	Schema of Response
requestId	string	Id of the request	479AE38F-A574-52F7-87EA-E91199999F9E
code	string	响应状态码。	Ok
message	string	响应消息。	success
data	object	响应数据。
consumerId	string	消费者 ID。	cs-cvnjramm1hks1r3fmmug

示例

正常返回示例

JSON格式

{
  "requestId": "479AE38F-A574-52F7-87EA-E91199999F9E",
  "code": "Ok",
  "message": "success",
  "data": {
    "consumerId": "cs-cvnjramm1hks1r3fmmug"
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。