文档首页/ AI开发平台ModelArts/ API参考/ APP认证管理/ 创建APP
更新时间：2024-10-23 GMT+08:00
查看PDF
分享

创建APP

功能介绍

创建API网关应用（简称APP），每个用户最多只能创建5个APP，有需求可以申请增加配额。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /v1/{project_id}/app-auth/apps

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

用户项目ID。获取方法请参见获取项目ID和名称。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

否

String

消息体的类型。设置为text/plain，返回临时预览链接。设置为application/octet-stream，返回临时下载链接。

X-Auth-Token

是

String

用户token
表3 请求Body参数

参数

是否必选

参数类型

描述

app_name

是

String

app名称。

app_remark

否

String

app备注。

workspace_id

否

String

工作空间ID。获取方法请参见查询工作空间列表。未创建工作空间时默认值为“0”，存在创建并使用的工作空间，以实际取值为准。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

app

ApigAppDetailInfo object

创建的APP基础信息。
表5 ApigAppDetailInfo

参数

参数类型

描述

app_codes

Array of strings

APP Code列表，当APP类型为APIC时，此参数为空。

app_id

String

APP编号。

app_key

String

APP的key。

app_name

String

APP名称。

app_remark

String

APP描述，默认为空。不超过200个字符。

app_secret

String

APP密钥。

app_type

String

APP类型。枚举值如下：

  • APIC：该APP注册在roma connect网关上

  • APIG：该APP注册在共享API网关上

  • DEDICATE_APIG：该APP注册在专享API网关上

bounded_api_count

Integer

APP绑定API数量。

created_at

Long

APP创建时间。

project_id

String

项目ID。

updated_at

Long

APP更新时间。

user_id

String

APP创建用户ID。

状态码： 401

表6 响应Body参数

参数

参数类型

描述

error_code

String

ModelArts错误码。

error_msg

String

具体错误信息。

状态码： 403

表7 响应Body参数

参数

参数类型

描述

error_code

String

ModelArts错误码。

error_msg

String

具体错误信息。

状态码： 404

表8 响应Body参数

参数

参数类型

描述

error_code

String

ModelArts错误码。

error_msg

String

具体错误信息。

请求示例

POST https://{endpoint}/v1/{project_id}/app-auth/apps

{
  "app_name" : "app_4ef0",
  "app_remark" : ""
}

响应示例

状态码： 200

OK

{
  "app" : {
    "app_id" : "logic-app-7ded3898-8306-49ee-a1df-2708f9aac83a",
    "app_name" : "app_c8ae",
    "app_key" : "9cdbfd0b65364fbe8b1c6cf29255a46f",
    "app_secret" : "c736b99bdc33403ab0652bf91c00e99e",
    "user_id" : "04f258c8fb00d42a1f65c00df88cc4dc",
    "project_id" : "04f258c84780d5a52f3bc00dc15aa5e7",
    "app_type" : "DEDICATE_APIG",
    "app_codes" : [ ],
    "created_at" : 1703162733450,
    "updated_at" : 1703162733450,
    "bounded_api_count" : 0
  }
}

状态码

状态码

描述

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码。

父主题： APP认证管理

相关文档