应用

管理应用程序配置及生命周期流程

---

查询应用列表

GET

/api/v1/app

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

查询参数

id

类型integer

format"int64"

code

类型string

name

类型string

showName

类型string

icon

类型string

type

类型string

枚举

"CLOUD_APP""BASE_APP""OP_APP"

editionType

类型string

枚举

"CLOUD_SERVICE""COMMUNITY""ENTERPRISE""DATACENTER"

authCtrl

类型boolean

enabled

类型boolean

url

类型string

sequence

类型integer

format"int32"

version

类型string

openStage

类型string

枚举

"SIGNUP""AUTH_PASSED""OPEN_SUCCESS"

clientId

类型string

apiId

类型integer

format"int64"

tagId

类型integer

format"int64"

createdBy

类型integer

format"int64"

tenantId

类型integer

format"int64"

createdDate

类型string

format"date-time"

pageNo

页面数据大小，默认为1，最大值为100000

类型integer

format"int32"

maximum100000

minimum1

pageSize

页面数据大小，默认为10，最大值为2000

类型integer

format"int32"

maximum2000

minimum1

orderBy

排序字段

类型string

orderSort

排序方法

类型string

枚举

"ASC""DESC"

filters[0].key

筛选字段名称

类型string

filters[0].op

筛选条件（等于、不等于、大于等）

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[0].value

筛选值

类型object

filters[1].key

筛选字段名称

类型string

filters[1].op

筛选条件（等于、不等于、大于等）

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[1].value

筛选值

类型object

filters[2].key

筛选字段名称

类型string

filters[2].op

筛选条件（等于、不等于、大于等）

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[2].value

筛选值

类型object

infoScope

查询信息范围

类型string

枚举

"BASIC""DETAIL"

响应

成功

Content-Type

*/*

"string"

GET

/api/v1/app

试验场

授权

UserHttpBearer

变量

键

值

id

code

name

showName

icon

type

editionType

authCtrl

enabled

url

sequence

version

openStage

clientId

apiId

tagId

createdBy

tenantId

createdDate

pageNo

pageSize

orderBy

orderSort

filters[0].key

filters[0].op

filters[0].value

filters[1].key

filters[1].op

filters[1].value

filters[2].key

filters[2].op

filters[2].value

infoScope

示例

cURL

JavaScript

PHP

Python

---

替换应用程序

PUT

/api/v1/app

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

查询参数

dto*

必填

响应

成功

Content-Type

*/*

"string"

PUT

/api/v1/app

试验场

授权

UserHttpBearer

变量

键

值

dto*

示例

cURL

JavaScript

PHP

Python

---

添加应用

POST

/api/v1/app

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

application/json

"string"

响应

成功

Content-Type

*/*

"string"

POST

/api/v1/app

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

删除应用程序

DELETE

/api/v1/app

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

查询参数

ids*

类型array

必填

maxItems200

minItems0

uniqueItemstrue

响应

成功

Content-Type

*/*

"string"

DELETE

/api/v1/app

试验场

授权

UserHttpBearer

变量

键

值

ids*

示例

cURL

JavaScript

PHP

Python

---

更新应用

PATCH

/api/v1/app

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

application/json

"string"

响应

成功

Content-Type

*/*

"string"

PATCH

/api/v1/app

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

更新应用站点信息

PATCH

/api/v1/app/site

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

application/json

"string"

响应

成功

Content-Type

*/*

"string"

PATCH

/api/v1/app/site

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

全文搜索应用程序列表

GET

/api/v1/app/search

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

查询参数

id

类型integer

format"int64"

code

类型string

name

类型string

showName

类型string

icon

类型string

type

类型string

枚举

"CLOUD_APP""BASE_APP""OP_APP"

editionType

类型string

枚举

"CLOUD_SERVICE""COMMUNITY""ENTERPRISE""DATACENTER"

authCtrl

类型boolean

enabled

类型boolean

url

类型string

sequence

类型integer

format"int32"

version

类型string

openStage

类型string

枚举

"SIGNUP""AUTH_PASSED""OPEN_SUCCESS"

clientId

类型string

apiId

类型integer

format"int64"

tagId

类型integer

format"int64"

createdBy

类型integer

format"int64"

tenantId

类型integer

format"int64"

createdDate

类型string

format"date-time"

pageNo

页面数据大小，默认为1，最大值为100000

类型integer

format"int32"

maximum100000

minimum1

pageSize

页面数据大小，默认为10，最大值为2000

类型integer

format"int32"

maximum2000

minimum1

orderBy

排序字段

类型string

orderSort

排序方法

类型string

枚举

"ASC""DESC"

filters[0].key

筛选字段名称

类型string

filters[0].op

筛选条件（等于、不等于、大于等）

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[0].value

筛选值

类型object

filters[1].key

筛选字段名称

类型string

filters[1].op

筛选条件（等于、不等于、大于等）

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[1].value

筛选值

类型object

filters[2].key

筛选字段名称

类型string

filters[2].op

筛选条件（等于、不等于、大于等）

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[2].value

筛选值

类型object

infoScope

查询信息范围

类型string

枚举

"BASIC""DETAIL"

响应

成功

Content-Type

*/*

"string"

GET

/api/v1/app/search

试验场

授权

UserHttpBearer

变量

键

值

id

code

name

showName

icon

type

editionType

authCtrl

enabled

url

sequence

version

openStage

clientId

apiId

tagId

createdBy

tenantId

createdDate

pageNo

pageSize

orderBy

orderSort

filters[0].key

filters[0].op

filters[0].value

filters[1].key

filters[1].op

filters[1].value

filters[2].key

filters[2].op

filters[2].value

infoScope

示例

cURL

JavaScript

PHP

Python

---

启用或禁用应用程序

PATCH

/api/v1/app/enabled

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

application/json

[

]

响应

成功

Content-Type

*/*

"string"

PATCH

/api/v1/app/enabled

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

导入应用

POST

/api/v1/app/import

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

查询参数

dto*

必填

请求体

application/json

{

"file": ""

}

响应

成功

Content-Type

*/*

"string"

POST

/api/v1/app/import

试验场

授权

UserHttpBearer

变量

键

值

dto*

主体

示例

cURL

JavaScript

PHP

Python

---

导出应用

GET

/api/v1/app/export

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

查询参数

id*

导出应用程序ID

类型integer

必填

format"int64"

exportType*

导出应用程序文件格式类型

类型string

必填

枚举

"JSON""CSV""EXCEL"

响应

成功

GET

/api/v1/app/export

试验场

授权

UserHttpBearer

变量

键

值

id*

exportType*

示例

cURL

JavaScript

PHP

Python

---

查询应用详情

GET

/api/v1/app/{id}

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

路径参数

id*

应用ID

类型integer

必填

format"int64"

响应

成功

Content-Type

*/*

"string"

GET

/api/v1/app/{id}

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

查询应用详情

GET

/api/v1/app/{code}/{editionType}

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

路径参数

code*

应用代码

类型string

必填

editionType*

应用版本类型

类型string

必填

枚举

"CLOUD_SERVICE""COMMUNITY""ENTERPRISE""DATACENTER"

响应

成功

Content-Type

*/*

"string"

GET

/api/v1/app/{code}/{editionType}

试验场

授权

UserHttpBearer

变量

键

值

code*

editionType*

示例

cURL

JavaScript

PHP

Python

---