AddGatewayAuthConsumer - 新增网关鉴权消费者_微服务引擎-阿里云帮助中心

新增网关鉴权消费者。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
GatewayUniqueId	string	是	网关唯一标识ID。	gw-c70622ff52fe49beb29bea9a6f52****
Name	string	是	鉴权消费者名称。	name
Type	string	是	鉴权类型： JWT	JWT
EncodeType	string	否	加密类型： RSA OCT	RSA
Jwks	string	否	JWT公钥，支持JSON格式。	{"keys":[{"e":"AQAB","kid":"DHFbpoIUqrY8t2zpA2qXfCmr5VO5ZEr4RzHU_-envvQ","kty":"RSA","n":"xAE7eB6qugXyCAG3yhh7pkDkT65pHymX-P7KfIupjf59vsdo91bSP9C8H07pSAGQO1MV_xFj9VswgsCg4R6otmg5PV2He95lZdHtOcU5DXIg_pbhLdKXbi66GlVeK6ABZOUW3WYtnNHD-91gVuoeJT_DwtGGcp4ignkgXfkiEm4sw-4sfb4qdt5oLbyVpmW6x9cfa7vs2WTfURiCrBoUqgBo_-4WTiULmmHSGZHOjzwa8WtrtOQGsAFjIbno85jp6MnGGGZPYZbDAa_b3y5u-YpW7ypZrvD8BgtKVjgtQgZhLAGezMt0ua3DRrWnKqTZ0BJ_EyxOGuHJrLsn00fnMQ"}]}
TokenName	string	否	要校验的Token参数信息的名称，默认是以Bearer为前缀放在Authorization header中，例如：`Authorization: Bearer token`。	Authorization
TokenPass	boolean	否	是否透传。	true
TokenPosition	string	否	要校验的Token参数信息的位置，默认是以Bearer为前缀放在Authorization header中，例如：`Authorization: Bearer token`。	HEADER
TokenPrefix	string	否	要校验的Token参数信息的前缀，默认是以Bearer为前缀放在Authorization header中，例如：`Authorization: Bearer token`。	Bearer
KeyName	string	否	JWT内身份标识KeyName。	iss
KeyValue	string	否	JWT内身份标识KeyValue。	abcd
Description	string	否	鉴权消费者描述。	description
AcceptLanguage	string	否	返回信息的语言类型： zh：中文 en：英文	zh

返回参数

名称	类型	描述	示例值
	object	RestResult<List>
RequestId	string	请求ID。	69AD2AA7-DB47-449B-941B-B14409DF****
Success	boolean	请求结果，取值如下： `true`：请求成功。 `false`：请求失败。	True
Code	integer	code仅仅用来和success同步	200
ErrorCode	string	错误码。	mse-100-000
HttpStatusCode	integer	HTTP返回码。	200
Message	string	返回信息。	请求处理成功
DynamicCode	string	动态错误信息中的占位符	code
DynamicMessage	string	动态错误信息，用于替换返回参数 `ErrMessage` 错误信息中的 `%s`。说明如果`ErrMessage`返回`The Value of Input Parameter %s is not valid`，且`DynamicMessage`返回`DtsJobId`，则代表所传入的请求参数`DtsJobId`不合法。	The specified parameter is invalid.
Data	long	鉴权消费者ID。	2

示例

正常返回示例

JSON格式

{
  "RequestId": "69AD2AA7-DB47-449B-941B-B14409DF****",
  "Success": true,
  "Code": 200,
  "ErrorCode": "mse-100-000",
  "HttpStatusCode": 200,
  "Message": "请求处理成功",
  "DynamicCode": "code",
  "DynamicMessage": "The specified parameter is invalid.",
  "Data": 2
}

错误码

HTTP status code	错误码	错误信息	描述
400	IllegalRequest	Invalid request:%s	非法请求： %s
400	InvalidParameter	Parameter error:%s	请求参数错误：%s
403	NoPermission	You are not authorized to perform this operation:%s	没有权限使用此接口：%s
404	NotFound	Not found:%s	资源不存在：%s
500	InternalError	Console error. Try again later:%s	控制台错误.稍后重试：%s

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