Change SNS Application Endpoint State

PUT/zstack/v1/sns/application-endpoints/{uuid}/actions

Request

cURL

curl --request PUT \
  --url '/v1/sns/application-endpoints/{uuid}/actions' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "status": "ok",
  "method": "PUT",
  "path": "/v1/sns/application-endpoints/{uuid}/actions"
}

Headers

Authorization: OAuth the-session-uuid

Body

{
  "changeSNSApplicationEndpointState": {
    "stateEvent": "disable"
  },
  "systemTags": [],
  "userTags": []
}

In the preceding example, the systemTags and userTags fields are optional. They are listed to indicate that the body can contain these two fields.

Curl Example

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"changeSNSApplicationEndpointState":{"stateEvent":"disable"}}' \
http://localhost:8080/zstack/v1/sns/application-endpoints/1485ef44ea5234ee83d80d3a15937e19/actions

Parameter List

Name	Type	Location	Description	Allowed Values	Starting Version
uuid	String	url	The UUID of the resource, uniquely identifying this resource		2.3
stateEvent	String	body (Contained in the changeSNSApplicationEndpointState structure)	State event	enable disable	2.3
systemTags (Optional)	List	body	System tags		2.3
userTags (Optional)	List	body	User tags		2.3

API Response

Response example

{
  "inventory": {
    "name": "example",
    "uuid": "917fe66f76b241f0843dfbd6be685fc1",
    "description": "description example",
    "type": "Email",
    "state": "Enabled",
    "platformUuid": "4eb0ceebf95b452585ebeacd647d9f35",
    "createDate": "Mar 26, 2024 2:44:26 AM",
    "lastOpDate": "Mar 26, 2024 2:44:26 AM"
  }
}

Name	Type	Description	Starting Version
success	boolean		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	2.3
inventory	SNSApplicationEndpointInventory	For details, see inventory	2.3

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	0.6
description	String	A brief description of the error	0.6
details	String	Detailed information about the error	0.6
elaboration	String	Reserved field. Defaults to null	0.6
opaque	LinkedHashMap	Reserved field. Defaults to null	0.6
cause	ErrorCode	The root error that caused the current error. This field is null if there is no root cause	0.6

inventory

Name	Type	Description	Starting Version
uuid	String	The UUID of the resource, uniquely identifying this resource	2.3
name	String	Resource name	2.3
description	String	Detailed description of the resource	2.3
type	String	Type	2.3
platformUuid	String	Application platform UUID	2.3
lastOpDate	Timestamp	Last modification time	2.3
createDate	Timestamp	Creation time	2.3

SDK Examples

Java SDK

ChangeSNSApplicationEndpointStateAction action = new ChangeSNSApplicationEndpointStateAction();
action.uuid = "1485ef44ea5234ee83d80d3a15937e19";
action.stateEvent = "disable";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
ChangeSNSApplicationEndpointStateAction.Result res = action.call();

Python SDK

ChangeSNSApplicationEndpointStateAction action = ChangeSNSApplicationEndpointStateAction()
action.uuid = "1485ef44ea5234ee83d80d3a15937e19"
action.stateEvent = "disable"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
ChangeSNSApplicationEndpointStateAction.Result res = action.call()