AI 助理
文档备案控制台
官方文档
首页

UndeployHttpApi - 下线API

更新时间：
复制 MD 格式
产品详情
我的收藏

取消部署HttpApi。

调试

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

调试

授权信息

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

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

apig:UndeployHttpApi

none

*HttpApi

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

 无 无

请求语法

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

路径参数

名称

类型

必填

描述

示例值
httpApiId

string

否

HTTP API ID。

api-cqu95allhtgii6***

请求参数

名称

类型

必填

描述

示例值
body

object

否

请求 body。

routeId

string

否

路由 ID。当下线 HTTP API 的路由时候，必须传入。

hr-cr82undlhtgrle***
environmentId

string

否

环境 ID。

env-cqsmtellhtgvo***
operationId

string

否

接口 ID

op-d4favr6m1hk***
gatewayId

string

否

网关 ID

gw-cq7l5s5lhtg***

返回参数

名称

类型

描述

示例值

object

Schema of Response

requestId

string

请求 ID。

3ACFC7A7-45A9-58CF-B2D5-765B60254695
code

string

响应状态码。

Ok
message

string

响应消息。

success

示例

正常返回示例

JSON格式

{
  "requestId": "3ACFC7A7-45A9-58CF-B2D5-765B60254695",
  "code": "Ok",
  "message": "success"
}

错误码

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

变更历史

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

上一篇：ListHttpApis - 获取HTTP API列表下一篇：DeleteHttpApi - 删除HTTP API