All Products
Search
Document Center

ListActions

Last Updated: Sep 02, 2019

You can call this operation to query available actions, including atomic actions and cloud product actions.

Request parameters

Parameter Type Required Example Description
Action String Yes ListActions The operation that you want to perform. Set this parameter to ListActions.
OOSActionName String No MyTemplate The name of the action. This operation returns all the actions whose names include the string that is specified by this parameter.
MaxResults Integer No 50 The number of entries to return on each page. Valid values: 20 to 100.
Default value: 50.
NextToken String No N/A The token that is required to retrieve the next page of results.

Response parameters

Parameter Type Example Description
RequestId String F9154C02-F847-4563-BB6A-6DD01A4F0 The ID of the request.
MaxResults Integer 50
Actions The list of actions.
└ OOSActionName String ACS::ECS::ReplaceSystemDisk The name of the action.
└ ActionType String ACS::Template The type of the action.
1. Atomic actions:
1.1 Atomic.API
1.2 Atomic.Trigger
1.3 Atomic.Control
1.4 Atomic.Embedded
2. Cloud product actions
2.1 Product.ECS
2.2 Product.RDS
2.3 Product.VPC
2.4 Product.FC
2.5 …
└ CreatedDate String 2019-05-16T10:26:14Z The time when the action was created.
└ Description String ReplaceSystemDisk The description of the action.
└ Properties Map {
“ImageId”: {
“Description”: “The mirror ID you will use when resetting the system”,
“Type”: “String”
},
“InstanceId”: {
“Description”: “the instance id that you will handle .”,
“Type”: “String”
}
}
The properties of the action.
└ TemplateVersion String v1 The corresponding template version of the action.
For atomic actions, no value is returned for this parameter.

Examples

Sample request

  1. https://oos.cn-hangzhou.aliyuncs.com/?Action=ListActions
  2. &<Common request parameters>

Sample success response
JSON format

  1. {
  2. "MaxResults": 50,
  3. "RequestId": "F9154C02-F847-4563-BB6A-6DD2F5F0",
  4. "Actions": [
  5. {
  6. "OOSActionName": "ACS::ECS::ReplaceSystemDisk",
  7. "ActionType": "Product.ECS",
  8. "CreatedDate": "2019-05-14T07:26:39Z",
  9. "Description": "ReplaceSystemDisk",
  10. "TemplateVersion": "v1",
  11. "Properties": {
  12. "ImageId": {
  13. "Description": "The mirror ID you will use when resetting the system",
  14. "Type": "String"
  15. },
  16. "InstanceId": {
  17. "Description": "the instance id that you will handle .",
  18. "Type": "String"
  19. }
  20. }
  21. },
  22. {
  23. "OOSActionName": "ACS::Notify",
  24. "ActionType": "Automic.Trigger",
  25. "CreatedDate": "2019-05-16T09:33:45Z",
  26. "Description": "Send the notification.",
  27. "Properties": {
  28. "NotifyType": "The type of notification. Support WebHook",
  29. "WebHook": {
  30. "Content": "The body for requesting web hook. Type: Mapping.",
  31. "Headers": "The headers for requesting web hook. Type: Mapping.",
  32. "URI": "The web hook URI."
  33. }
  34. }
  35. }
  36. }

Error codes

Error code HTTP status code Error message Description
InvalidVersion 400 The specified Version is invalid. The error message returned because the specified version is invalid. Specify a valid version in the URL and try again.
InvalidAction.NotFound 400 Specified api is not found, please check your url and method. The error message returned because the specified operation does not exist. Specify a valid value for the Action parameter.
Throttling.User 400 Your request was denied due to instance flow control. The error message returned because too many requests have been sent over a short period of time. Try again later.
User.NoPermission 401 User has no permission to do the action: ({api_name}) The error message returned because the user is not authorized to call this operation. Check whether the current user is authorized to call the OOS API operation in the RAM console.
InvalidStsToken 400 Invalid STS token to do the action: ({api_name}) The error message returned because the specified STS token is invalid.
ExpiredStsToken 400 Expired STS token to do the action: ({api_name}) The error message returned because the specified STS token has expired.
InvalidAccountType 400 The account type ({account_type}) was not supported. The error message returned because the specified account type is not supported.
InvalidNextToken 400 The NextToken is invalid. The error message returned because the specified next token is invalid.
InvalidNextTokenQuery 400 Query parameters changed for the next token. The error message returned because the NextToken parameter is specified for the current request but the parameter settings used for this current request are different from those used for the first request.