文档首页/ 应用与数据集成平台 ROMA Connect/ API参考（阿布扎比区域）/ 公共资源API/ 应用管理/ 创建应用
更新时间：2022-12-05 GMT+08:00
查看PDF
分享

创建应用

功能介绍

创建应用

URI

POST /v2/{project_id}/instances/{instance_id}/apps

表1 路径参数

参数

是否必选

参数类型

描述

instance_id

是

String

实例ID

最小长度：0

最大长度：64

project_id

是

String

项目ID

最小长度：0

最大长度：64

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）

最小长度：1

最大长度：100000
表3 请求Body参数

参数

是否必选

参数类型

描述

name

是

String

应用名称

  • 字符集：支持中文、英文字母、数字、中划线、下划线、点、空格和中英文圆括号

  • 约束：实例下唯一

remark

否

String

应用描述

key

否

String

应用认证访问KEY,未提供时随机生成

  • 字符集：支持中文、英文字母、数字、中划线、下划线、@号和点，以字母或中文或数字开头

  • 约束：实例下唯一

secret

否

String

应用认证访问SECRET,未提供（字段不存在或值为null）时随机生成

  • 字符集：英文字母、数字、！、@、#、$、%、+、=、点、中划线、斜线/

  • 复杂度：满足大小写字母、数字、特殊字符的复杂度组合，考虑兼容性暂时不做复杂度校验

favorite

否

Object

收藏的应用

响应参数

状态码： 201

表4 响应Body参数

参数

参数类型

描述

id

String

应用ID

name

String

应用名称

  • 字符集：支持中文、英文字母、数字、中划线、下划线、点、空格和中英文圆括号

  • 约束：实例下唯一

remark

String

应用描述

roles

Array of strings

应用权限角色

  • read：应用下资源只读权限，至少要存在此权限，包括API调试

  • access：应用下资源的访问管理权限

  • delete：应用下资源的删除权限

  • modify：应用下资源的修改权限，包括API发布、下线

  • admin：应用和应用下资源的权限

  • 仅提供admin时，会自动应用其它所有权限

  • 未提供read时会自动应用read权限

create_time

Number

创建时间

最小值：1

最大值：128

update_time

Number

更新时间

最小值：1

最大值：128

created_user

created_user object

创建用户信息

last_updated_user

last_updated_user object

最后更新用户信息

owner

Boolean

是否是应用拥有者

key

String

应用认证访问KEY,未提供时随机生成

  • 字符集：支持中文、英文字母、数字、中划线、下划线、@号和点，以字母或中文或数字开头

  • 约束：实例下唯一

favorite

Boolean

是否收藏应用，收藏的应用会在列表里优先显示
表5 created_user

参数

参数类型

描述

user_id

String

创建应用的用户ID

user_name

String

创建应用的用户名称
表6 last_updated_user

参数

参数类型

描述

user_id

String

最后修改者的用户ID

user_name

String

最后修改者的用户名

状态码： 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：1

最大长度：128

error_msg

String

错误消息

最小长度：1

最大长度：128

error_details

String

具体错误消息

最小长度：1

最大长度：128

request_id

String

请求处理ID

最小长度：1

最大长度：128

suggestion

String

处理建议

最小长度：1

最大长度：128

请求示例

{
  "name" : "AppName",
  "remark" : "App description",
  "key" : "JNs1VK3vLdTT9Djd",
  "secret" : "TEI95R8RZ2pIf8UM",
  "favorite" : false
}

响应示例

状态码： 201

OK

{
  "id" : "b2e6b145-4f3f-4a80-aa45-f4b8029f95a3",
  "name" : "AppName",
  "newRemark" : "App description",
  "roles" : [ "read, access, delete, modify, admin" ],
  "create_time" : "2019-12-06T06:49:04.000Z",
  "update_time" : "2019-12-06T06:49:04.000Z",
  "created_user" : {
    "user_id" : "string",
    "user_name" : "string"
  },
  "last_updated_user" : {
    "user_id" : "string",
    "user_name" : "string"
  },
  "owner" : true,
  "key" : "TEI95R8RZ2pIf8UM",
  "favorite" : true
}

状态码： 400

Bad Request

{
  "error_code" : "ROMA.00014002",
  "error_msg" : "instance not found",
  "error_details" : "",
  "suggestion" : "",
  "equest_id" : "affb720d23ef9ab6c4535b7f3528b489"
}

状态码

状态码

描述

201

OK

400

Bad Request

错误码

请参见错误码。

父主题： 应用管理