ScenarioMonitor

Scenario Monitoring Config - Configure and manage monitoring rules to track system health at the API level, enabling proactive issue detection and remediation

---

Query the list of scenario monitor

GET

/api/v1/scenario/monitor

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

projectId*

Project id

类型integer

必填

format"int64"

id

Monitor id

类型integer

format"int64"

name

Monitor name

类型string

scenarioId

Monitor scenario id

类型integer

format"int64"

status

类型string

枚举

"PENDING""SUCCESS""FAILURE"

createdBy

类型integer

format"int64"

createdDate

类型string

format"date-time"

lastModifiedBy

类型integer

format"int64"

lastModifiedDate

类型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/scenario/monitor

试验场

授权

UserHttpBearer

变量

键

值

projectId*

id

name

scenarioId

status

createdBy

createdDate

lastModifiedBy

lastModifiedDate

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 scenario monitor

PUT

/api/v1/scenario/monitor

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

{

"id": 0,

"scenarioId": 0,

"name": "string",

"description": "string",

"timeSetting": {

"createdAt": "string",

"createdAtSomeDate": "string",

"periodicCreationUnit": "string",

"dayOfWeek": "string",

"dayOfMonth": 0,

"timeOfDay": "14:30:00",

"hourOfDay": 0,

"minuteOfHour": 0,

"onetime": true

},

"serverSetting": [

{

"url": "https://{env}-api.xcan.cloud:{port}/{basePath}",

"description": "The production API server",

"variables": {

"extensions": {

"additionalProperties": {

}

},

"empty": true,

"additionalProperties": {

}

},

"extensions": {

"additionalProperties": {

}

},

"emptyContent": true,

"notEmptyContent": true

}

],

"noticeSetting": {

"enabled": true,

"orgType": "string",

"orgs": [

{

"id": 0,

"name": "string"

}

]

}

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

/api/v1/scenario/monitor

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Create scenario monitor

POST

/api/v1/scenario/monitor

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

{

"scenarioId": 0,

"name": "string",

"description": "string",

"timeSetting": {

"createdAt": "string",

"createdAtSomeDate": "string",

"periodicCreationUnit": "string",

"dayOfWeek": "string",

"dayOfMonth": 0,

"timeOfDay": "14:30:00",

"hourOfDay": 0,

"minuteOfHour": 0,

"onetime": true

},

"serverSetting": [

{

"url": "https://{env}-api.xcan.cloud:{port}/{basePath}",

"description": "The production API server",

"variables": {

"extensions": {

"additionalProperties": {

}

},

"empty": true,

"additionalProperties": {

}

},

"extensions": {

"additionalProperties": {

}

},

"emptyContent": true,

"notEmptyContent": true

}

],

"noticeSetting": {

"enabled": true,

"orgType": "string",

"orgs": [

{

"id": 0,

"name": "string"

}

]

}

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

POST

/api/v1/scenario/monitor

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Delete scenario monitor

DELETE

/api/v1/scenario/monitor

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

ids*

Scenario monitor ids

类型array

必填

maxItems200

minItems0

uniqueItemstrue

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

DELETE

/api/v1/scenario/monitor

试验场

授权

UserHttpBearer

变量

键

值

ids*

示例

cURL

JavaScript

PHP

Python

---

Update scenario monitor

PATCH

/api/v1/scenario/monitor

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

{

"id": 0,

"name": "string",

"description": "string",

"timeSetting": {

"createdAt": "string",

"createdAtSomeDate": "string",

"periodicCreationUnit": "string",

"dayOfWeek": "string",

"dayOfMonth": 0,

"timeOfDay": "14:30:00",

"hourOfDay": 0,

"minuteOfHour": 0,

"onetime": true

},

"serverSetting": [

{

"url": "https://{env}-api.xcan.cloud:{port}/{basePath}",

"description": "The production API server",

"variables": {

"extensions": {

"additionalProperties": {

}

},

"empty": true,

"additionalProperties": {

}

},

"extensions": {

"additionalProperties": {

}

},

"emptyContent": true,

"notEmptyContent": true

}

],

"noticeSetting": {

"enabled": true,

"orgType": "string",

"orgs": [

{

"id": 0,

"name": "string"

}

]

}

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PATCH

/api/v1/scenario/monitor

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Run scenario monitoring immediately

POST

/api/v1/scenario/monitor/{id}/run

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Scenario monitor id

类型integer

必填

format"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

POST

/api/v1/scenario/monitor/{id}/run

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

Query the detail of scenario monitor

GET

/api/v1/scenario/monitor/{id}

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Scenario monitor id

类型integer

必填

format"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/scenario/monitor/{id}

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

Fulltext search the list of scenario monitor

GET

/api/v1/scenario/monitor/search

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

projectId*

Project id

类型integer

必填

format"int64"

id

Monitor id

类型integer

format"int64"

name

Monitor name

类型string

scenarioId

Monitor scenario id

类型integer

format"int64"

status

类型string

枚举

"PENDING""SUCCESS""FAILURE"

createdBy

类型integer

format"int64"

createdDate

类型string

format"date-time"

lastModifiedBy

类型integer

format"int64"

lastModifiedDate

类型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/scenario/monitor/search

试验场

授权

UserHttpBearer

变量

键

值

projectId*

id

name

scenarioId

status

createdBy

createdDate

lastModifiedBy

lastModifiedDate

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

---