文档首页/ 微服务引擎 CSE/ API参考/ 应用网关API/ 创建http转rpc方法
更新时间：2024-12-12 GMT+08:00
查看PDF
分享

创建http转rpc方法

功能介绍

创建http转rpc方法。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /v2/{project_id}/enginemgr/gateways/{gateway_id}/http2Rpcs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目id。

gateway_id

是

String

网关实例id。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

IAM-Token。

Accept

否

String

该字段内容填为 "application/json"。
表3 请求Body参数

参数

是否必选

参数类型

描述

gatewayId

否

String

网关的ID。

pluginConfig

否

Object

传递给插件的配置。

name

否

String

http2rpc插件名称。

routeName

否

String

路由的名称。

routeDestinationName

否

String

目标路由的名称。

dubbo

否

Dubbo object

dubbo服务的信息。
表4 Dubbo

参数

是否必选

参数类型

描述

service

否

String

服务名。

version

否

String

版本号。

group

否

String

分组。

methods

否

Array of DubboMethod objects

dubbo方法列表。
表5 DubboMethod

参数

是否必选

参数类型

描述

serviceMethod

否

String

服务方法。

headersAttach

否

String

附加请求头。

httpMethods

否

Array of strings

http 方法。

httpPath

否

String

http 路径。

params

否

Array of DubboMethodParam objects

dubbo 方法参数。
表6 DubboMethodParam

参数

是否必选

参数类型

描述

paramKey

否

String

参数键。

paramSource

否

String

参数来源。

paramType

否

String

参数类型。

响应参数

状态码： 200

表7 响应Body参数

参数

参数类型

描述

gatewayId

String

网关的ID。

pluginConfig

Object

传递给插件的配置。

name

String

http2rpc插件名称。

routeName

String

路由的名称。

routeDestinationName

String

目标路由的名称。

dubbo

Dubbo object

dubbo 服务的信息。
表8 Dubbo

参数

参数类型

描述

service

String

服务名。

version

String

版本号。

group

String

分组。

methods

Array of DubboMethod objects

dubbo方法列表。
表9 DubboMethod

参数

参数类型

描述

serviceMethod

String

服务方法。

headersAttach

String

附加请求头。

httpMethods

Array of strings

http方法。

httpPath

String

http路径。

params

Array of DubboMethodParam objects

dubbo方法参数。
表10 DubboMethodParam

参数

参数类型

描述

paramKey

String

参数键。

paramSource

String

参数来源。

paramType

String

参数类型。

状态码： 400

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误信息。

detail

String

详细定位信息。

请求示例

POST https://{endpoint}/v2/{project_id}/enginemgr/gateways/{gateway_id}/http2Rpcs

{
  "gatewayId" : "string",
  "pluginConfig" : { },
  "name" : "string",
  "routeName" : "string",
  "routeDestinationName" : "string",
  "dubbo" : {
    "service" : "string",
    "version" : "string",
    "group" : "string",
    "methods" : [ {
      "serviceMethod" : "string",
      "headersAttach" : "string",
      "httpMethods" : [ "string" ],
      "httpPath" : "string",
      "params" : [ {
        "paramKey" : "string",
        "paramSource" : "string",
        "paramType" : "string"
      } ]
    } ]
  }
}

响应示例

状态码： 200

创建成功

{
  "gatewayId" : "string",
  "pluginConfig" : { },
  "name" : "string",
  "routeName" : "string",
  "routeDestinationName" : "string",
  "dubbo" : {
    "service" : "string",
    "version" : "string",
    "group" : "string",
    "methods" : [ {
      "serviceMethod" : "string",
      "headersAttach" : "string",
      "httpMethods" : [ "string" ],
      "httpPath" : "string",
      "params" : [ {
        "paramKey" : "string",
        "paramSource" : "string",
        "paramType" : "string"
      } ]
    } ]
  }
}

状态码

状态码

描述

200

创建成功。

400

创建失败。

错误码

请参见CSE错误码。

父主题： 应用网关API

相关文档