Get Disks

Table 1. API: GET GCP Disks
Element Description
API GetDisk
Description API returns disks in endpoint.
Method GET
URL Http(s)://{xx.xxxx.xx.xx:xxx}/v3/gcp/provisioningEndPoints/{endpointId}/disks
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": "zoneName=’us-east1-b’","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": "DISK-077AB789-FFAB-4500-B61B-E78318A1EB98",
 "diskId": "xxxxxx",
 "name": "wndevohs01",
 "description": "",
 "diskType": "Zonal",
 "sizeGb": 150,
 "kind": "compute#disk",
 "regionName": "",
 "region": "",
 "replicaZones": "",
 "zoneName": "us-east1-b",
 "zone": "https://www.googleapis.com/compute/v1/projects/xxxxxx/zones/us-east1-b",
 "selfLink": "https://www.googleapis.com/compute/v1/projects/xxxxxx/zones/us-east1-b/disks/wndevohs01",
 "labelFingerPrint": "42WmSpB8rSM=",
 "licenseCodes": [
 "xxxxxx"
 ],
 "associatedServicePlans": [
 {
 "servicePlanId": "1",
 "servicePlanName": "platinum"
 }
 ]
 }
 ]
}
Response Parameters
  • Result:
  • entityId
  • diskId
  • name
  • description
  • diskType
  • sizeGb
  • kind
  • regionName
  • region
  • replicaZones
  • zoneName
  • zone
  • labelFingerPrint
  • licenseCodes
  • associatedServicePlans