Queries the list of EventHouse runtimes.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| MaxResults |
integer |
No |
The maximum number of runtimes to return per page. If this parameter is not specified or set to 0, the default value 20 is used. Maximum value: 100. |
20 |
| NextToken |
string |
No |
Not required for the first query. For subsequent queries, use the NextToken returned in the previous response. An empty value indicates that no more pages are available. |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| Message |
string |
The message returned by the operation. |
Operation success |
| RequestId |
string |
The request ID. |
34AD682D-5B91-5773-8132-AA38C130**** |
| Data |
object |
The runtime list result. |
|
| Runtimes |
array |
The list of runtimes. |
|
| EventHouseRuntime | |||
| MaxResults |
integer |
20 |
|
| NextToken |
string |
||
| TotalCount |
integer |
1 |
|
| Code |
string |
The response code. Success indicates that the operation was successful. |
Success |
| Success |
boolean |
Indicates whether the operation was successful. |
true |
Examples
Success response
JSON format
{
"Message": "Operation success",
"RequestId": "34AD682D-5B91-5773-8132-AA38C130****",
"Data": {
"Runtimes": [
{
"Name": "default",
"Status": "RUNNING",
"Cu": 2,
"Progress": 80,
"Stage": "RUNTIME_HEALTH_CHECK",
"TargetCu": 2,
"ErrorCode": "RUNTIME_OPERATION_TIMEOUT",
"ErrorMessage": "Runtime operation timed out"
}
],
"MaxResults": 20,
"NextToken": "",
"TotalCount": 1
},
"Code": "Success",
"Success": true
}Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 403 | ServiceNotEnable | Service not enable |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.