API Reference | ZStack ZSphere · ZVF | ZStack Resource Center

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 Example

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

Run the CLI tool, enter QuerySNSEmailAddress and press Tab to view all queryable fields and cross-table queryable resource names.

API Response

Response example

{
  "inventories": [
    {
      "uuid": "102431efdb133a70b7e04347de22e396",
      "emailAddress": "test@zstack.io",
      "endpointUuid": "4ff65a1d7762348495dd0c4da110d7cd",
      "createDate": "Mar 26, 2024 2:46:41 AM",
      "lastOpDate": "Nov 14, 2017 2:20:57 PM"
    }
  ]
}

Name	Type	Description	Starting Version
success	boolean	Whether the operation succeeded.	5.0.0
error	ErrorCode	Error code. If not null, the operation failed. This field is null when the operation succeeds. For details, see error	3.7.0
inventories	List	For details, see inventories	3.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 or HOST.1001	3.7.0
description	String	A brief description of the error	3.7.0
details	String	Detailed information about the error	3.7.0
elaboration	String	Reserved field. Defaults to null	3.7.0
opaque	LinkedHashMap	Reserved field. Defaults to null	3.7.0
cause	ErrorCode	The root error that caused the current error. This field is null if there is no root cause	3.7.0

#inventories

Name	Type	Description	Starting Version
uuid	String	The UUID of the resource, uniquely identifying this resource	3.7.0
emailAddress	String	The email address.	3.7.0
endpointUuid	String	The endpoint UUID.	3.7.0
createDate	Timestamp	Creation time	3.7.0
lastOpDate	Timestamp	Last modification time	3.7.0

SDK Examples

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()