QuerySNSSmsEndpoint

API Request

URLs

GET zstack/v1/sns/sms-endpoints
GET zstack/v1/sns/sms-endpoints/{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/sms-endpoints?q=name=SmsEndpoint

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

Queryable Fields

You can check all queryable fields and resource names that can be queried across tables by using zstack-cli, entering QuerySNSSmsEndpoint, 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

QuerySNSSmsEndpointAction action = new QuerySNSSmsEndpointAction();
action.conditions = asList("name=SmsEndpoint");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QuerySNSSmsEndpointAction.Result res = action.call();

Python SDK

QuerySNSSmsEndpointAction action = QuerySNSSmsEndpointAction()
action.conditions = ["name=SmsEndpoint"]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QuerySNSSmsEndpointAction.Result res = action.call()