文档

CreateApp - 创建APP

更新时间:

创建API网关的APP。

接口说明

  • 此功能面向调用 API 的用户
  • 每个 APP 有一对 Key 和 Value 密钥对,该密钥在调用 API 时用于身份验证
  • APP 调用 API 需要建立授权关系,即授予 APP 调用某 API 的权限
  • 一个 APP 下只能有一对密钥,若密钥泄露可以重置
  • 每个阿里云账号创建 APP 的个数上限是 1000 个
  • 该接口调用的 QPS 限制为:单用户 QPS 不超过 50

调试

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

授权信息

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

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

请求参数

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

APP 名称。支持汉字、英文字母、数字、英文格式的下划线,且必须以字母或汉字开始,长度限制为 4~26 个字符

CreateAppTest
Descriptionstring

APP 描述信息,长度不超过 180 个字符

test
Tagarray<object>

指定规则所适用的对象标签,可设置多个。

Key, Value
object
Keystring

标签键。

n 的取值范围为 [1, 20]

env
Valuestring

标签值。

n 的取值范围为 [1, 20]。当参数有值,要求对应当 tag.N.Key 在相同的 N 的标签键也传入值,否则会报错。

' '
AppKeystring

App 的 Key,用于调用 API 时使用

60030986
AppSecretstring

App 的密码

nzyNqFkRWB2uLw86
AppCodestring

应用的 AppCode

3aaf905a0a1f4f0eabc6d891dfa08afc
Extendstring

扩展信息

110210264071

返回参数

名称类型描述示例值
object
TagStatusboolean

标签是否存在,取值为:-true:存在-false:不存在

false
RequestIdstring

请求 ID

BA20890E-75C7-41BC-9C8B-73276B58F550
AppIdlong

APP 的唯一编号

20112314518278

示例

正常返回示例

JSON格式

{
  "TagStatus": false,
  "RequestId": "BA20890E-75C7-41BC-9C8B-73276B58F550",
  "AppId": 20112314518278
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-07-28OpenAPI 入参发生变更查看变更详情
2023-03-23OpenAPI 入参发生变更查看变更详情