全部产品
Search

搜索本产品

    微服务引擎MSE：UpdateGatewayAuthConsumer - 更新网关鉴权消费者

    文档中心

    微服务引擎MSE：UpdateGatewayAuthConsumer - 更新网关鉴权消费者

    更新时间：Nov 13, 2024

    更新网关鉴权消费者。

    调试

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

    授权信息

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

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    mse:UpdateGatewayAuthConsumer
    • Gateway
      acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}
      无
    		无

    请求参数

    名称类型必填描述示例值
    GatewayUniqueIdstring是

    网关唯一 ID。

    		gw-90392d768a3847a7b804c505254d****
    EncodeTypestring否

    加密类型：

    • RSA

    • OCT

    		RSA
    Jwksstring否

    JWT 公钥，支持 JSON 格式。

    		{"keys":[{"e":"AQAB","kid":"DHFbpoIUqrY8t2zpA2qXfCmr5VO5ZEr4RzHU_-envvQ","kty":"RSA","n":"xAE7eB6qugXyCAG3yhh7pkDkT65pHymX-P7KfIupjf59vsdo91bSP9C8H07pSAGQO1MV_xFj9VswgsCg4R6otmg5PV2He95lZdHtOcU5DXIg_pbhLdKXbi66GlVeK6ABZOUW3WYtnNHD-91gVuoeJT_DwtGGcp4ignkgXfkiEm4sw-4sfb4qdt5oLbyVpmW6x9cfa7vs2WTfURiCrBoUqgBo_-4WTiULmmHSGZHOjzwa8WtrtOQGsAFjIbno85jp6MnGGGZPYZbDAa_b3y5u-YpW7ypZrvD8BgtKVjgtQgZhLAGezMt0ua3DRrWnKqTZ0BJ_EyxOGuHJrLsn00fnMQ"}]}
    TokenNamestring否

    要校验的 Token 参数信息的名称，默认是以 Bearer 为前缀放在 Authorization header 中，例如：Authorization: Bearer token。

    		Authorization
    TokenPassboolean否

    是否透传。

    		true
    TokenPositionstring否

    要校验的 Token 参数信息的位置，默认是以 Bearer 为前缀放在 Authorization header 中，例如：Authorization: Bearer token。

    		HEADER
    TokenPrefixstring否

    要校验的 Token 参数信息的前缀，默认是以 Bearer 为前缀放在 Authorization header 中，例如：Authorization: Bearer token。

    		Bearer
    KeyNamestring否

    JWT 内身份标识 KeyName。

    		iss
    KeyValuestring否

    JWT 内身份标识 KeyValue。

    		abcd
    Descriptionstring否

    鉴权消费者描述。

    		这是描述
    Idlong是

    鉴权消费者 ID。

    		63
    AcceptLanguagestring否

    返回信息的语言类型：

    • zh：中文
    • en：英文
    		zh

    返回参数

    名称类型描述示例值
    object

    RestResult<List>

    RequestIdstring

    请求 ID。

    		EE5C32A1-BC0E-4B79-817C-103E4EDF****
    Successboolean

    请求结果，取值如下：

    • true：请求成功。
    • false：请求失败。
    		true
    Codeinteger

    code 仅仅用来和 success 同步。

    		200
    ErrorCodestring

    错误码。

    		mse-100-000
    HttpStatusCodeinteger

    HTTP 状态码。

    		200
    Messagestring

    返回信息。

    		请求处理成功
    DynamicCodestring

    动态错误信息中的占位符。

    		code
    DynamicMessagestring

    动态错误信息，用于替换返回参数 ErrMessage 错误信息中的**%s**。

    说明 如果 ErrMessage 返回The Value of Input Parameter %s is not valid，且 DynamicMessage 返回 DtsJobId，则代表所传入的请求参数 DtsJobId 不合法。
    		The specified parameter is invalid.
    Datalong

    鉴权消费者 ID。

    		2

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "EE5C32A1-BC0E-4B79-817C-103E4EDF****",
  "Success": true,
  "Code": 200,
  "ErrorCode": "mse-100-000",
  "HttpStatusCode": 200,
  "Message": "请求处理成功",
  "DynamicCode": "code",
  "DynamicMessage": "The specified parameter is invalid.",
  "Data": 2
}

    错误码

    HTTP status code错误码错误信息描述
    400IllegalRequestInvalid request:%s非法请求： %s
    400InvalidParameterParameter error:%s请求参数错误：%s
    403NoPermissionYou are not authorized to perform this operation:%s没有权限使用此接口：%s
    404NotFoundNot found:%s资源不存在：%s
    500InternalErrorConsole error. Try again later:%s控制台错误.稍后重试：%s

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

    变更历史

    变更时间变更内容概要操作
    2024-02-23API 内部配置变更，不影响调用查看变更详情