App

Manages application configurations and lifecycle processes

---

Query the list of application

GET

/api/v1/app

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型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

Page data size, default 1, maximum 100000

类型integer

format"int32"

maximum100000

minimum1

pageSize

Page data size, default 10, maximum 2000

类型integer

format"int32"

maximum2000

minimum1

orderBy

Sort field

类型string

orderSort

Sorting method

类型string

枚举

"ASC""DESC"

filters[0].key

Filter field name

类型string

filters[0].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型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

Filter value

filters[1].key

Filter field name

类型string

filters[1].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型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

Filter value

filters[2].key

Filter field name

类型string

filters[2].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型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

Filter value

infoScope

Query information scope

类型string

枚举

"BASIC""DETAIL"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

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

---

Replace application

PUT

/api/v1/app

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

dto*

类型object

必填

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

/api/v1/app

试验场

服务器

授权

UserHttpBearer

变量

键

值

dto*

示例

cURL

JavaScript

PHP

Python

---

Add application

POST

/api/v1/app

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

{

"code": "AngusTester",

"name": "AngusTester",

"showName": "AngusTester",

"icon": "http://dev-files.xcan.cloud/storage/api/v1/file/AngusTester.icon",

"type": "string",

"editionType": "string",

"description": "string",

"authCtrl": true,

"url": "http://dev-tester.xcan.cloud/",

"sequence": 1000,

"apiIds": [

0

],

"version": "string",

"openStage": "string",

"clientId": "xcan_tp",

"tagIds": [

0

]

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

POST

/api/v1/app

试验场

服务器

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Delete applications

DELETE

/api/v1/app

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

ids*

类型array

必填

maxItems200

minItems0

uniqueItemstrue

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

DELETE

/api/v1/app

试验场

服务器

授权

UserHttpBearer

变量

键

值

ids*

示例

cURL

JavaScript

PHP

Python

---

Update application

PATCH

/api/v1/app

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

{

"id": 0,

"code": "AngusTester",

"name": "AngusTester",

"showName": "AngusTester",

"icon": "http://dev-files.xcan.cloud/storage/api/v1/file/AngusTester.icon",

"type": "string",

"editionType": "string",

"description": "string",

"authCtrl": true,

"url": "http://dev-tester.xcan.cloud/",

"sequence": 1000,

"apiIds": [

0

],

"version": "string",

"openStage": "string",

"clientId": "xcan_tp",

"tagIds": [

0

]

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PATCH

/api/v1/app

试验场

服务器

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Import application

POST

/api/v1/app/import

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

dto*

类型object

必填

请求体

application/json

{

"file": ""

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

POST

/api/v1/app/import

试验场

服务器

授权

UserHttpBearer

变量

键

值

dto*

主体

示例

cURL

JavaScript

PHP

Python

---

Update application site information

PATCH

/api/v1/app/site

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

{

"id": 0,

"showName": "AngusTester",

"icon": "http://dev-files.xcan.cloud/storage/api/v1/file/AngusTester.icon",

"url": "http://dev-tester.xcan.cloud/"

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PATCH

/api/v1/app/site

试验场

服务器

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Enable or disable applications

PATCH

/api/v1/app/enabled

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

[

{

"id": 1,

"enabled": true

}

]

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PATCH

/api/v1/app/enabled

试验场

服务器

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Query the detail of application

GET

/api/v1/app/{id}

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Application id

类型integer

必填

format"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/app/{id}

试验场

服务器

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

Query the detail of application

GET

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

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

code*

Application code

类型string

必填

editionType*

Application edition type

类型string

必填

枚举

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

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

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

试验场

服务器

授权

UserHttpBearer

变量

键

值

code*

editionType*

示例

cURL

JavaScript

PHP

Python

---

Fulltext search the list of application

GET

/api/v1/app/search

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型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

Page data size, default 1, maximum 100000

类型integer

format"int32"

maximum100000

minimum1

pageSize

Page data size, default 10, maximum 2000

类型integer

format"int32"

maximum2000

minimum1

orderBy

Sort field

类型string

orderSort

Sorting method

类型string

枚举

"ASC""DESC"

filters[0].key

Filter field name

类型string

filters[0].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型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

Filter value

filters[1].key

Filter field name

类型string

filters[1].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型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

Filter value

filters[2].key

Filter field name

类型string

filters[2].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型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

Filter value

infoScope

Query information scope

类型string

枚举

"BASIC""DETAIL"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

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

---

Export application

GET

/api/v1/app/export

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

id*

Export application id

类型integer

必填

format"int64"

exportType*

Export application file format type

类型string

必填

枚举

"JSON""CSV""EXCEL"

响应

OK

GET

/api/v1/app/export

试验场

服务器

授权

UserHttpBearer

变量

键

值

id*

exportType*

示例

cURL

JavaScript

PHP

Python

---