Get_allocated_bitmap
POST v1/volumes/id/actions/get_allocated_bitmap
Description
Scan a segment within a volume and return a bitmap of the non-zero chunks.
Normal Response Codes
200
HTTP Error Codes
400 401 403 404 409 500 503
Detail Codes
Request
| Parameter | Type | JSON Type | Description | Mandatory |
|---|---|---|---|---|
| id | NsObjectID | string | ID of the volume to scan. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | true |
| segment_start_offset_bytes | NsUnsignedLong | number | The starting byte offset of the segment to scan. Must be a multiple of the chunk size. Unsigned 64-bit integer. Example: 1234. | true |
| segment_length_bytes | NsUnsignedLong | number | The length in bytes of the segment to scan. Must be a multiple of the chunk size. Unsigned 64-bit integer. Example: 1234. | true |
| chunk_size_bytes | NsUnsignedLong | number | The number of bytes represented by a bit in the bitmap. Must be a multiple of the volume's block size. Unsigned 64-bit integer. Example: 1234. | true |
| timeout_secs | NsUnsignedLong | number | A limit on the time (in seconds) to generate a result. If a full result cannot be computed in this time, a partial result will be returned instead. The bitmap for a partial result will be shorter than expected and will comprise whole bytes. Unsigned 64-bit integer. Example: 1234. | true |
JSON Request
{
"data" : {
"segment_start_offset_bytes" : 0,
"segment_length_bytes" : 1048576,
"chunk_size_bytes" : 65536,
"timeout_secs" : 30
}
}
Response
Type: NsBitMapReturn
| Member | Type | JSON Type | Description |
|---|---|---|---|
| bitmap | NsBitMap | string | Returned bitmap. A hexadecimal number with maximum of 8192 characters. Example: '0810'. |
JSON Response
{
"data" : {
"bitmap" : "0810"
}
}