API Reference | 5.4.12 | ZStack Cloud · ZCF

API Request

URLs

GET zstack/v1/sns/application-endpoints/emails/email-addresses

GET zstack/v1/sns/application-endpoints/emails/email-addresses/{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/emails/email-addresses?q=uuid=b1a8e21bed1e3592af8ba5ffff497af6&q=endpointUuid=547ffd3cbdb2399d8c6dde2d983502d5

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/sns/application-endpoints/emails/email-addresses/9c1b8131d9a03e3b88602a5072a89c0b

Queryable Fields

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

API Response

Sample Response

{
  "inventories": [
    {
      "uuid": "102431efdb133a70b7e04347de22e396",
      "emailAddress": "test@zstack.io",
      "endpointUuid": "4ff65a1d7762348495dd0c4da110d7cd",
      "createDate": "Dec 25, 2023 2:08:35 PM",
      "lastOpDate": "Nov 14, 2017 10:20:57 PM"
    }
  ]
}

Name	Type	Description	Starting Version
success	boolean		5.0.0
error	ErrorCode	The error code. If not null, the operation fails, or vice versa. For more information, see error.	3.7.0
inventories	List	See inventories.	3.7.0

#error

Name	Type	Description	Starting Version
code	String	The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.	3.7.0
description	String	The brief description of the error.	3.7.0
details	String	The details about the error.	3.7.0
elaboration	String	The reserved field. Default value: null.	3.7.0
opaque	LinkedHashMap	The reserved field. Default value: null.	3.7.0
cause	ErrorCode	The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.	3.7.0

#inventories

Name	Type	Description	Starting Version
uuid	String	The resource UUID.	3.7.0
emailAddress	String		3.7.0
endpointUuid	String		3.7.0
createDate	Timestamp	The creation date.	3.7.0
lastOpDate	Timestamp	The last operation date.	3.7.0

SDK Sample

Java SDK

QuerySNSEmailAddressAction action = new QuerySNSEmailAddressAction();
action.conditions = asList("uuid=19beae4d7df63aa6ba24b7422521af7b","endpointUuid=4758483d0db33c6bb82961d4c1e837aa");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QuerySNSEmailAddressAction.Result res = action.call();

Python SDK

QuerySNSEmailAddressAction action = QuerySNSEmailAddressAction()
action.conditions = ["uuid=2ab2f6138c1c3b98b5834764c29dd596","endpointUuid=01106fe537473575be43fec7173e2dd1"]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QuerySNSEmailAddressAction.Result res = action.call()