Ops Center Automator REST API User and Reference Guide

Version: 11.0.x
Audience: anonymous
Part Number: MK-99AUT003-21

About Hitachi Ops Center Automator API
REST architecture
Hitachi Ops Center Automator API functionality
API prerequisites
Resources managed through the API
Identifying a resource
Supported HTTP methods
Security and authentication
Resource attributes
Input and output formats
Supported API resources
Common resource attributes
Query string
Using the query filter
Domain object convention
Using the output of an action object
Providing message responses to URI request errors
Requesting the status of an invoked action
Specifying collection information
Specifying pagination properties
Warning message format for failure to connect to the external server
Hitachi Ops Center Automator REST API use cases
Use case reference table
Use cases for finding and managing services
Find service by service name
Get top 10 most frequently used services
Change service state to release
Change service state to maintenance
Delete a service by service name
Use cases for creating and submitting service requests
Create and submit service request (run immediately)
Create and submit service request (schedule)
Create and submit service request, then get the result after the task is completed
Get result by task ID after task completed
Use cases for finding and managing tasks
Find long-running tasks
Find tasks waiting for user input
Stop running all tasks by service name
Stop running a task by task ID
Archive completed tasks
Cancel all scheduled tasks by service name
Cancel scheduled task by task ID
Suspend all scheduled tasks by service name
Suspend a scheduled task by task ID
Resume all suspended tasks by service name
Resume a suspended task by task ID
Resubmit a task
Hitachi Ops Center Automator REST API command set
Services
Getting a list of services
Selecting a service
Editing a service
Deleting a service
Getting a list of service actions
Preparing to submit a service
Submitting a service
Preparing to reset a service
Resetting the counter of a service
Preparing to release a service
Releasing a service
Preparing to change the configuration type of a service to maintenance
Changing the configuration type of a service to maintenance
Preparing to disable a service
Disabling a service
Getting service help
Preparing to apply a service template
Applying a service template
Schedules
Getting a list of scheduled services
Selecting a targeted service schedule
Getting a list of scheduled actions
Preparing to cancel a scheduled service
Canceling a scheduled service
Preparing to suspend a scheduled service
Suspending a scheduled service
Preparing to resume a scheduled service
Resuming a scheduled service
Tasks
Getting a list of tasks
Selecting a task
Getting a list of task actions
Preparing to stop a task
Stopping a task
Preparing to force stop a task
Forcibly stopping a task
Preparing to resubmit a task
Resubmitting a task
Preparing to archive a task
Retrieving information to archive a task
Archiving a task
Preparing to rerun a task from the failed step
Rerunning a task from the failed step
Preparing to rerun a task after the failed step
Rerunning a task after the failed step
Updating a task
Preparing to respond to a task
Responding to a task
Task histories
Getting a list of task histories
Deleting task histories
Selecting a task history
Deleting a task history
Getting a list of task history actions
Property definitions
Getting a list of property definitions
Getting a property definition
Getting a list of property definitions actions
Property values
Getting a list of property values
Getting a property value
Editing a specified property value
Editing multiple instances of a property value
Getting a list of property values actions
Service groups
Getting a list of service groups
Creating a service group
Selecting a service group
Editing a service group
Deleting a service group
Getting a list of service group actions
Preparing to assign a service group to a user group with a role
Assigning a service group to a user group
Preparing to unassign a service group
Unassigning a service group
Service template
Getting a list of service templates
Selecting a service template
Deleting a service template
Getting a list of service template actions
Preparing to import a service template
Importing a service template
Preparing to export a service template
Exporting a service template
Getting service template help
Preparing to bind and run a service template
Binding and running a service template
Property information
Getting a list of property information
Property groups
Getting a list of property groups
Task logs
Getting a task log
Tag groups
Getting a list of tag groups
Tags
Getting a list of tags for a resource
External server connection
Getting a list of external server connections
Host
Getting a list of hosts
Storage systems
Getting a list of storage systems
Other resources
Getting user information
Getting the version information
Reference information
HTTP status codes
Using the log file for API troubleshooting
API resource map
Service and content properties list
Add host to cluster in vCenter service properties
Add host to cluster in vCenter service (edit)
Add host to cluster in vCenter service (submit)
Add host to cluster in vCenter service (task details)
Allocate fabric aware volumes and create datastore for ESX cluster
Allocate fabric aware volumes and create datastore for ESX cluster (edit)
Allocate fabric aware volumes and create datastore for ESX cluster (submit)
Allocate fabric aware volumes and create datastore for ESX cluster (task details)
Allocate fabric aware volumes with Configuration Manager service properties
Allocate fabric aware volumes with Configuration Manager (edit)
Allocate fabric aware volumes with Configuration Manager (submit)
Allocate fabric aware volumes with Configuration Manager (task details)
Allocate Volumes, Fabric, and Datastore for ESXi Host service properties
Allocate Volumes, Fabric, and Datastore for ESXi Host (edit)
Allocate Volumes, Fabric, and Datastore for ESXi Host (submit)
Allocate Volumes, Fabric, and Datastore for ESXi Host (task details)
Allocate Volumes with 2DC Remote Replication service properties
Allocate Volumes with 2DC Remote Replication service (edit)
Allocate Volumes with 2DC Remote Replication service (submit)
Allocate Volumes with 2DC Remote Replication service (task details)
Allocate volumes with Clone/Snapshot service properties
Allocate volumes with clone/snapshot service (edit)
Allocate volumes with clone/snapshot service (submit)
Allocate volumes with clone/snapshot service (task details)
Allocate Volumes with Remote Replication (Global-Active Device) service properties
Allocate Volumes with Remote Replication (global-active device) (edit)
Allocate Volumes with Remote Replication (global-active device) (submit)
Allocate Volumes with Remote Replication (global-active device) (task details)
Allocate volumes with Smart Provisioning service properties
Allocate Volumes with Smart Provisioning (edit)
Allocate Volumes with Smart Provisioning (submit)
Allocate Volumes with Smart Provisioning (task details)
Clean up Online Migration Pair service properties
Clean up Online Migration Pair service properties (edit)
Clean up Online Migration Pair service properties (submit)
Clean up Online Migration Pair service properties (task details)
Create Online Migration Pair service properties
Create Online Migration Pair (edit)
Create Online Migration Pair (submit)
Create Online Migration Pair (task details)
Create Online Migration Pairs for Multiple Hosts service properties
Create Online Migration Pairs for Multiple Hosts (edit)
Create Online Migration Pairs for Multiple Hosts (submit)
Create Online Migration Pairs for Mulitple Hosts (task details)
Global-Active Device Setup service properties
Global-Active Device Setup (edit)
Global-Active Device Setup (submit)
Global-Active Device Setup (task details)
Migrate Data for Online Migration Pair service properties
Migrate Data for Online Migration Pair (edit)
Migrate Data for Online Migration Pair (submit)
Migrate Data for Online Migration Pair (task details)
Remove host from cluster in vCenter service properties
Remove host from cluster in vCenter service (edit)
Remove host from cluster in vCenter service (submit)
Remove host from cluster in vCenter service (task details)
Notices
Notices

Back to home page