调用ExportHttpApi接口导出HTTP API定义-API 网关-阿里云-API 网关(API Gateway)-阿里云帮助中心

导出指定的HTTP API。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

apig:ExportHttpApi

none

*HttpApi

acs:apig:{#regionId}:{#accountId}:httpapi/{#HttpApiId}

无

请求语法

POST /v1/http-apis/{httpApiId}/export HTTP/1.1

路径参数

名称	类型	必填	描述	示例值
httpApiId	string	是	HTTP API ID。	api-xxx

请求参数

名称	类型	必填	描述	示例值
body	object	否	导出配置
gatewayId	string	否	导出网关拓展信息时，需指定网关实例 ID	gw-xxx
operationIds	array	否	导出 REST API 时选择导出某几个接口
	string	否	网关拓展信息配置	op-xxxx
extensionConfig	object	否	是否到处插件配置
withPlugin	boolean	否	是否到处插件配置
withPolicy	boolean	否	是否到处策略配置
withService	boolean	否	是否到处后端服务
withAuthConfig	boolean	否	是否到处接口或路由的消费者授权配置
withAuthConsumer	boolean	否	是否到处授权的消费者

返回参数

名称	类型	描述	示例值
	object	响应。
requestId	string	请求 ID。	4BACB05C-3FE2-588F-9148-700C5C026B74
code	string	响应状态码。	Ok
message	string	响应消息。	success
data	object	API 定义信息。
specContentBase64	string	Base64 编码的 API 定义。	b3BlbmFwaTogMy4wLjAKaW5mbzoKICAgIHRpdGxlOiBkZW1vCiAgICBkZXNjcmlwdGlvbjogdGhpc2lzZGVtbwogICAgdmVyc2lvbjogIiIKcGF0aHM6CiAgICAvdXNlci97dXNlcklkfToKICAgICAgICBnZXQ6CiAgICAgICAgICAgIHN1bW1hcnk6IOiOt+WPlueUqOaIt+S/oeaBrwogICAgICAgICAgICBkZXNjcmlwdGlvbjog6I635Y+W55So5oi35L+h5oGvCiAgICAgICAgICAgIG9wZXJhdGlvbklkOiBHZXRVc2VySW5mbwogICAgICAgICAgICByZXNwb25zZXM6CiAgICAgICAgICAgICAgICAiMjAwIjoKICAgICAgICAgICAgICAgICAgICBkZXNjcmlwdGlvbjog5oiQ5YqfCiAgICAgICAgICAgICAgICAgICAgY29udGVudDoKICAgICAgICAgICAgICAgICAgICAgICAgYXBwbGljYXRpb24vanNvbjtjaGFyc2V0PXV0Zi04OgogICAgICAgICAgICAgICAgICAgICAgICAgICAgc2NoZW1hOiBudWxsCnNlcnZlcnM6CiAgICAtIHVybDogaHR0cDovL2FwaS5leGFtcGxlLmNvbS92MQo=

示例

正常返回示例

JSON格式

{
  "requestId": "4BACB05C-3FE2-588F-9148-700C5C026B74",
  "code": "Ok",
  "message": "success",
  "data": {
    "specContentBase64": "b3BlbmFwaTogMy4wLjAKaW5mbzoKICAgIHRpdGxlOiBkZW1vCiAgICBkZXNjcmlwdGlvbjogdGhpc2lzZGVtbwogICAgdmVyc2lvbjogIiIKcGF0aHM6CiAgICAvdXNlci97dXNlcklkfToKICAgICAgICBnZXQ6CiAgICAgICAgICAgIHN1bW1hcnk6IOiOt+WPlueUqOaIt+S/oeaBrwogICAgICAgICAgICBkZXNjcmlwdGlvbjog6I635Y+W55So5oi35L+h5oGvCiAgICAgICAgICAgIG9wZXJhdGlvbklkOiBHZXRVc2VySW5mbwogICAgICAgICAgICByZXNwb25zZXM6CiAgICAgICAgICAgICAgICAiMjAwIjoKICAgICAgICAgICAgICAgICAgICBkZXNjcmlwdGlvbjog5oiQ5YqfCiAgICAgICAgICAgICAgICAgICAgY29udGVudDoKICAgICAgICAgICAgICAgICAgICAgICAgYXBwbGljYXRpb24vanNvbjtjaGFyc2V0PXV0Zi04OgogICAgICAgICAgICAgICAgICAgICAgICAgICAgc2NoZW1hOiBudWxsCnNlcnZlcnM6CiAgICAtIHVybDogaHR0cDovL2FwaS5leGFtcGxlLmNvbS92MQo="
  }
}

错误码

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

变更历史

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