1.5 API request list
The JP1/OA API supports the following requests and HTTP methods:
Applications(Domain : objects)
Request |
Method |
URI |
Execution permission |
---|---|---|---|
Obtaining Application List |
GET |
/v1/objects/Applications |
Admin, Modify |
Collectors(Domain : objects)
Request |
Method |
URI |
Execution permission |
---|---|---|---|
Obtaining Collector List |
GET |
/v1/objects/Collectors |
Admin, Modify |
Creating Collector |
POST |
/v1/objects/Collectors |
Admin |
Obtaining Collector Information |
GET |
/v1/objects/Collectors/{id} |
Admin, Modify |
Updating Collector |
PUT |
/v1/objects/Collectors/{id} |
Admin |
Deleting Collector |
DELETE |
/v1/objects/Collectors/{id} |
Admin |
Credentials(Domain : objects)
Request |
Method |
URI |
Execution permission |
---|---|---|---|
Obtaining Authentication |
GET |
/v1/objects/Credentials |
Admin |
Creating Authentication |
POST |
/v1/objects/Credentials |
Admin |
Obtaining Authentication Information |
GET |
/v1/objects/Credentials/{id} |
Admin |
Updating Authentication |
PUT |
/v1/objects/Credentials/{id} |
Admin |
Deleting Authentication |
DELETE |
/v1/objects/Credentials/{id} |
Admin |
E2EView(Domain : services)
Request |
Method |
URI |
Execution permission |
---|---|---|---|
Collecting the information required to collect, into a CSV file, information about specified resources or a list of related resources |
GET |
/v1/services/E2EView/actions/getNodesDataCSV |
Admin, Modify |
Collecting, into a CSV file, information about specified resources or a list of related resources |
POST |
/v1/services/E2EView/actions/getNodesDataCSV/invoke |
Admin, Modify |
Events(Domain : services)
Request |
Method |
URI |
Execution permission |
---|---|---|---|
Collecting the information required to collect, into a CSV file, a list of events |
GET |
/v1/services/Events/actions/getEventDataCSV |
Admin, Modify |
Collecting, into a CSV file, a list of events |
POST |
/v1/services/Events/actions/getEventDataCSV/invoke |
Admin, Modify |
FCSwitches(Domain : objects)
Request |
Method |
URI |
Execution permission |
---|---|---|---|
Obtaining FC Switch List |
GET |
/v1/objects/FCSwitches |
Admin, Modify |
FCSwitches(Domain : services)
Request |
Method |
URI |
Execution permission |
---|---|---|---|
Obtaining FC Switch Operation List |
GET |
/v1/services/FCSwitches/actions |
Admin, Modify |
Obtaining FC Switch Monitoring Status Change Information |
GET |
/v1/services/FCSwitches/actions/changeManagedType |
Admin, Modify |
Changing FC Switch Monitoring Status |
POST |
/v1/services/FCSwitches/actions/changeManagedType/invoke |
Admin, Modify |
Grades(Domain : objects)
Request |
Method |
URI |
Execution permission |
---|---|---|---|
Obtaining Grade List |
GET |
/v1/objects/Grades |
Admin, Modify |
Groups(Domain : objects)
Request |
Method |
URI |
Execution permission |
---|---|---|---|
Obtaining Consumer List |
GET |
/v1/objects/Groups |
Admin, Modify |
Creating consumer |
POST |
/v1/objects/Groups |
Admin, Modify |
Getting specific consumer information |
GET |
/v1/objects/Groups/{id} |
Admin, Modify |
Updating consumer |
PUT |
/v1/objects/Groups/{id} |
Admin, Modify |
Deleting specific consumer |
DELETE |
/v1/objects/Groups/{id} |
Admin, Modify |
Obtaining Consumer Operation List |
GET |
/v1/objects/Groups/{id}/actions |
Admin, Modify |
Obtaining Consumer Allocation Information |
GET |
/v1/objects/Groups/{id}/actions/updateTargetResource |
Admin, Modify |
Allocating Consumer |
POST |
/v1/objects/Groups/{id}/actions/updateTargetResource/invoke |
Admin, Modify |
Obtaining Consumer Allocation Information with a Specified Resource Allocation Category |
GET |
/v1/objects/Groups/{id}/actions/updateTargetResourceWithAssignmentType |
Admin, Modify |
Allocating Consumers that Have a Resource Allocation Category Specified |
POST |
/v1/objects/Groups/{id}/actions/updateTargetResourceWithAssignmentType/invoke |
Admin, Modify |
Hosts(Domain : objects)
Request |
Method |
URI |
Execution permission |
---|---|---|---|
Obtaining Host List |
GET |
/v1/objects/Hosts |
Admin, Modify |
Hosts(Domain : services)
Request |
Method |
URI |
Execution permission |
---|---|---|---|
Obtaining Host Operation List |
GET |
/v1/services/Hosts/actions |
Admin, Modify |
Obtaining Host Monitoring Status Change Information |
GET |
/v1/services/Hosts/actions/changeManagedType |
Admin, Modify |
Changing Host Monitoring Status |
POST |
/v1/services/Hosts/actions/changeManagedType/invoke |
Admin, Modify |
Hypervisors(Domain : objects)
Request |
Method |
URI |
Execution permission |
---|---|---|---|
Obtaining Hypervisor List |
GET |
/v1/objects/Hypervisors |
Admin, Modify |
Hypervisors(Domain : services)
Request |
Method |
URI |
Execution permission |
---|---|---|---|
Obtaining Hypervisor Operation List |
GET |
/v1/services/Hypervisors/actions |
Admin, Modify |
Obtaining Hypervisor Monitoring Status Change Information |
GET |
/v1/services/Hypervisors/actions/changeManagedType |
Admin, Modify |
Changing Hypervisor Monitoring Status |
POST |
/v1/services/Hypervisors/actions/changeManagedType/invoke |
Admin, Modify |
IPSwitches(Domain : objects)
Request |
Method |
URI |
Execution permission |
---|---|---|---|
Obtaining IP Switch List |
GET |
/v1/objects/IPSwitches |
Admin, Modify |
IPSwitches(Domain : services)
Request |
Method |
URI |
Execution permission |
---|---|---|---|
Obtaining IP Switch Operation List |
GET |
/v1/services/IPSwitches/actions |
Admin, Modify |
Obtaining IP Switch Monitoring Status Change Information |
GET |
/v1/services/IPSwitches/actions/changeManagedType |
Admin, Modify |
Changing IP Switch Monitoring Status |
POST |
/v1/services/IPSwitches/actions/changeManagedType/invoke |
Admin, Modify |
IpAddrRanges(Domain : objects)
Request |
Method |
URI |
Execution permission |
---|---|---|---|
Obtaining Retrieval Ranges |
GET |
/v1/objects/IpAddrRanges |
Admin |
Creating Retrieval Ranges |
POST |
/v1/objects/IpAddrRanges |
Admin |
Obtaining Retrieval Range Information |
GET |
/v1/objects/IpAddrRanges/{id} |
Admin |
Updating Retrieval Ranges |
PUT |
/v1/objects/IpAddrRanges/{id} |
Admin |
Deleting Retrieval Ranges |
DELETE |
/v1/objects/IpAddrRanges/{id} |
Admin |
PerfComponents(Domain : services)
Request |
Method |
URI |
Execution permission |
---|---|---|---|
Collecting the information required to collect, into a CSV file, the performance values in a time series of specified performance information |
GET |
/v1/services/PerfComponents/actions/getGraphDataCSV |
Admin, Modify |
Collecting, into a CSV file, the performance values in a time series of specified performance information |
POST |
/v1/services/PerfComponents/actions/getGraphDataCSV/invoke |
Admin, Modify |
Collecting the information required to collect, into a CSV file, the latest value in the performance information that a specified resource holds |
GET |
/v1/services/PerfComponents/actions/getNodesGraphDataCSV |
Admin, Modify |
Collecting, into a CSV file, the latest value in the performance information that a specified resource holds |
POST |
/v1/services/PerfComponents/actions/getNodesGraphDataCSV/invoke |
Admin, Modify |
StorageSystems(Domain : objects)
Request |
Method |
URI |
Execution permission |
---|---|---|---|
Obtaining Storage System List |
GET |
/v1/objects/StorageSystems |
Admin, Modify |
StorageSystems(Domain : services)
Request |
Method |
URI |
Execution permission |
---|---|---|---|
Obtaining Storage System Operation List |
GET |
/v1/services/StorageSystems/actions |
Admin, Modify |
Obtaining Storage System Monitoring Status Change Information |
GET |
/v1/services/StorageSystems/actions/changeManagedType |
Admin, Modify |
Changing Storage System Monitoring Status |
POST |
/v1/services/StorageSystems/actions/changeManagedType/invoke |
Admin, Modify |
SystemThresholdProfiles(Domain : objects)
Request |
Method |
URI |
Execution permission |
---|---|---|---|
Obtaining System Profile List |
GET |
/v1/objects/SystemThresholdProfiles |
Admin, Modify |
Creating System Profile |
POST |
/v1/objects/SystemThresholdProfiles |
Admin, Modify |
Obtaining System Profile Information |
GET |
/v1/objects/SystemThresholdProfiles/{id} |
Admin, Modify |
Updating System Profile |
PUT |
/v1/objects/SystemThresholdProfiles/{id} |
Admin, Modify |
Delete System Profiles |
DELETE |
/v1/objects/SystemThresholdProfiles/{id} |
Admin, Modify |
Obtaining System Profile Operation List |
GET |
/v1/objects/SystemThresholdProfiles/{id}/actions |
Admin, Modify |
Obtaining System Profile Allocation Information |
GET |
/v1/objects/SystemThresholdProfiles/{id}/actions/updateTargetResource |
Admin, Modify |
Allocating System Profile |
POST |
/v1/objects/SystemThresholdProfiles/{id}/actions/updateTargetResource/invoke |
Admin, Modify |
UserThresholdProfiles(Domain : objects)
Request |
Method |
URI |
Execution permission |
---|---|---|---|
Obtaining User Profile List |
GET |
/v1/objects/UserThresholdProfiles |
Admin, Modify |
Creating User Profile |
POST |
/v1/objects/UserThresholdProfiles |
Admin, Modify |
Obtaining User Profile Information |
GET |
/v1/objects/UserThresholdProfiles/{id} |
Admin, Modify |
Updating User Profile |
PUT |
/v1/objects/UserThresholdProfiles/{id} |
Admin, Modify |
Delete User Profiles |
DELETE |
/v1/objects/UserThresholdProfiles/{id} |
Admin, Modify |
Obtaining User Profile Operation |
GET |
/v1/objects/UserThresholdProfiles/{id}/actions |
Admin, Modify |
Obtaining User Profile Allocation Information |
GET |
/v1/objects/UserThresholdProfiles/{id}/actions/updateTargetResource |
Admin, Modify |
Allocating User Profile |
POST |
/v1/objects/UserThresholdProfiles/{id}/actions/updateTargetResource/invoke |
Admin, Modify |
VirtualMachines(Domain : objects)
Request |
Method |
URI |
Execution permission |
---|---|---|---|
Obtaining Virtual Machine List |
GET |
/v1/objects/VirtualMachines |
Admin, Modify |
VirtualMachines(Domain : services)
Request |
Method |
URI |
Execution permission |
---|---|---|---|
Obtaining Virtual Machine Operation List |
GET |
/v1/services/VirtualMachines/actions |
Admin, Modify |
Obtaining Virtual Machine Monitoring Status Change Information |
GET |
/v1/services/VirtualMachines/actions/changeManagedType |
Admin, Modify |
Changing Virtual Machine Monitoring Status |
POST |
/v1/services/VirtualMachines/actions/changeManagedType/invoke |
Admin, Modify |
Volumes(Domain : objects)
Request |
Method |
URI |
Execution permission |
---|---|---|---|
Obtaining Volume List |
GET |
/v1/objects/Volumes |
Admin, Modify |
version(Domain : configuration)
Request |
Method |
URI |
Execution permission |
---|---|---|---|
Obtaining Version Information |
GET |
/v1/configuration/version |
Admin, Modify |