API Reference | 5.4.12 | ZStack Cloud · ZCF

API Request

URLs

GET zstack/v1/sns/application-endpoints/universal-sms

GET zstack/v1/sns/application-endpoints/universal-sms/{uuid}

Headers

Authorization: OAuth the-session-uuid

Curl Sample

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/sns/application-endpoints/universal-sms?q=url=http://universal-sms-url

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/sns/application-endpoints/universal-sms/004b6a5c2ad13e3eaf53db006d47eaf2

Queryable Fields

You can check all queryable fields and resource names that can be queried across tables by using zstack-cli, entering QuerySNSUniversalSmsEndpoint, and pressing the Tab key.

API Response

When the API succeeded, an empty JSON structure {} is returned. When the API failed, the returned JSON structure includes an error field. For example,

{
    "error": {
        "code": "SYS.1001",
        "description": "A message or a operation timeout",
        "details": "Create VM on KVM timeout after 300s"
    }
}

SDK Sample

Java SDK

QuerySNSUniversalSmsEndpointAction action = new QuerySNSUniversalSmsEndpointAction();
action.conditions = asList("url=http://universal-sms-url");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QuerySNSUniversalSmsEndpointAction.Result res = action.call();

Python SDK

QuerySNSUniversalSmsEndpointAction action = QuerySNSUniversalSmsEndpointAction()
action.conditions = ["url=http://universal-sms-url"]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QuerySNSUniversalSmsEndpointAction.Result res = action.call()