GetEventHouseRuntime - EventBridge - Alibaba Cloud Documentation Center

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
Name	string	No	The name of the EventHouse Runtime. If this parameter is not specified, the default Runtime is queried.	default

Response elements

Element	Type	Description	Example
	object
Message	string	The response message.	Operation success
RequestId	string	The request ID.	34AD682D-5B91-5773-8132-AA38C130****
Data	EventHouseRuntime	The Runtime information.
Code	string	The response code. Success indicates a successful operation.	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": {
    "Name": "default",
    "Status": "RUNNING",
    "Cu": 2,
    "Progress": 80,
    "Stage": "RUNTIME_HEALTH_CHECK",
    "TargetCu": 2,
    "ErrorCode": "RUNTIME_OPERATION_TIMEOUT",
    "ErrorMessage": "Runtime operation timed out"
  },
  "Code": "Success",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
403	ServiceNotEnable	Service not enable
404	RuntimeNotFound	Runtime not found

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.