Get EBS

Table 1. API: GET AWS EBS
Element Description
API GetAWSEBS
Description API returns AWS ebs(s) exist in Endpoint.
Method GET
URL Http://{xx. xxxx.xx.xx:xxx}/v3/aws/provisioningEndPoints/{endpointId}/ebss
URL Parameters (fields in curly {} braces)
  • endpointId (Mandatory): This is a unique identifier of Cloud Endpoint created in HCL BigFix CLM. It can be any value either PlatformEntityId or Name of the Platform available on Manage Provisioning Platform screen.
  • queryParams (Optional): It is used for filtering and sorting of records. It has three properties, which are as follows:
  • Filter: To filter records based on column name received from output. E.g. Filter="keyname='keyvalue'"
  • Sort Order: To define sorting order either ASC (Ascending) or DESC (descending). E.g. Sortorder="ASC".
  • Page Number: To get the records for related page number. Eg. Pagenumber="1”
  • Page Size: To get the number of records on selected page. Eg. Pagesize="10”
  • For e.g.
    {"filter": "regionName=’us-east-1’","sortorder": "desc", "pagenumber" : "1", "pagesize" : "10"}
Header
  • Authorization Key: The initial step that needs to be performed before consuming HCL BigFix CLM API is to obtain the Token Value for an authorization key. Once a Token value is obtained, it remains valid for all API calls made in a session. For more information on how to do that, refer Token API description.
  • Content-type: application/json
Response

A Sample Response:

{
"totalRecords": 3,
 "records": [
 {
 "entityId": null,
 "name": "vol-xxxxxx",
 "size": "10",
 "isRootDevice": "N",
 "instanceId": "i-xxxxxx",
 "userEntityId": "",
 "regionName": "us-east-1",
 "availabilityZoneName": "us-east-1a",
 "attachmentTime": "2020-08-14 05:59:12.0000000",
 "attachmentStatus": "attached",
 "deviceName": "/dev/sda1",
 "ebsType": "gp2",
 "iops": "100",
 "parentSnapShotEntityId": "snap-0c4e8263cef786d91",
 "alarmStatus": "",
 "ebsState": "1",
 "tagName": [
 {
 "Key": "Owner",
 "Value": "Kk"
 },
 {
 "Key": "Name",
 "Value": "ebs3"
 }
 ],
 "associatedServicePlans": [
 {
 "servicePlanId": "2",
 "servicePlanName": "silver"
 }
 ]
 }
 ]
 }
Response Parameters
  • Result:
  • entityId
  • name
  • size
  • isRootDevice
  • instanceId
  • regionName
  • availabilityZoneName
  • attachmentTime
  • attachmentStatus
  • deviceName
  • ebsType
  • iops
  • parentSnapShotEntityId
  • alarmStatus
  • ebsState
  • tagName
  • associatedServicePlans