AI 助理
文档备案控制台
官方文档
输入文档关键字查找
首页

DeployApi - 发布 API

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

发布API到指定的运行环境。

接口说明

  • 此功能面向开放 API 的用户，定义的 API 只有发布到运行环境，才能被调用

  • API 发布到集群里需要一定的时间，最长 5 秒后生效

  • 该接口调用的 QPS 限制为：单用户 QPS 不超过 50

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

apigateway:DeployApi

get

*ApiGroup

acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}

 无 无

请求参数

名称

类型

必填

描述

示例值
GroupId

string

否

分组编号

63be9002440b4778a61122f14c2b2bbb
ApiId

string

是

API 编号

d6f679aeb3be4b91b3688e887ca1fe16
StageName

string

是

运行环境名称，取值：

  • RELEASE：线上

  • PRE：预发

  • TEST：测试

RELEASE
Description

string

是

本次发布备注说明

for_test1

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID

CEF72CEB-54B6-4AE8-B225-F876FF7BZ015

示例

正常返回示例

JSON格式

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ015"
}

错误码

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

变更历史

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

上一篇：AbolishApi - 下线 API下一篇：BatchDeployApis - 批量发布API