文档

DeployApi - 发布 API

更新时间:

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

接口说明

  • 此功能面向开放 API 的用户,定义的 API 只有发布到运行环境,才能被调用
  • API 发布到集群里需要一定的时间,最长 5 秒后生效
  • 该接口调用的 QPS 限制为:单用户 QPS 不超过 50

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
apigateway:DeployApiWrite
  • 全部资源
    *

请求参数

名称类型必填描述示例值
GroupIdstring

分组编号

63be9002440b4778a61122f14c2b2bbb
ApiIdstring

API 编号

d6f679aeb3be4b91b3688e887ca1fe16
StageNamestring

运行环境名称,取值:

  • RELEASE:线上
  • PRE:预发
  • TEST:测试
RELEASE
Descriptionstring

本次发布备注说明

for_test1

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID

CEF72CEB-54B6-4AE8-B225-F876FF7BZ015

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)