Get External Services

GET/zstack/v1/external/services

Headers

Authorization: OAuth the-session-uuid

Curl Example

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/external/services

Parameter List

Name	Type	Location	Description	Allowed Values	Starting Version
systemTags (Optional)	List	query	System tags		4.7.0
userTags (Optional)	List	query	User tags		4.7.0

API Response

Response Example

{
  "inventories": [
    {
      "name": "prometheus",
      "status": "RUNNING",
      "capabilities": {
        "reloadConfig": true
      }
    }
  ]
}

Name	Type	Description	Starting Version
success	boolean		4.7.0
inventories	List	See inventories for details	4.7.0
error	ErrorCode	The error code. If not null, the operation failed. This field is null when the operation succeeds. See error for details	4.7.0

inventories

Name	Type	Description	Starting Version
name	String	Resource name	4.7.0
status	String	Service status	4.7.0
capabilities	ExternalServiceCapabilities	See capabilities for details	4.7.0

capabilities

Name	Type	Description	Starting Version
reloadConfig	boolean	Supports reloading configuration	4.7.0

error

Name	Type	Description	Starting Version
code	String	The error code number. A globally unique identifier for the error, for example, SYS.1000, HOST.1001	0.6
description	String	A brief description of the error	0.6
details	String	The detailed error information	0.6
elaboration	String	Reserved field. Default is null	0.6
opaque	LinkedHashMap	Reserved field. Default is null	0.6
cause	ErrorCode	The root error that caused the current error. If no root error exists, this field is null	0.6

SDK Examples

Java SDK

GetExternalServicesAction action = new GetExternalServicesAction();
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetExternalServicesAction.Result res = action.call();

Python SDK

GetExternalServicesAction action = GetExternalServicesAction()
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
GetExternalServicesAction.Result res = action.call()