List stored segments

Virtual Storage Platform One Object API Reference Guide

Version
3.0.x
File Size
270 KB
Audience
anonymous
Part Number
MK-24VSP1OB002-01

Lists all of the stored segments on a system. This call is reserved for Hitachi Vantara support.

Endpoint

POST /client_object/lookup

Request structure

{
  "bucketName": "string",
  "objectName": "string"
}
Parameter Type Description
bucketName String The name of the bucket containing the stored segments.
objectName String The name of the object associated with the stored segments.

Response structure

{
    "shards": [
      {
        "storageComponentId": "string",
        "path": "string"
      }
    ]
  }
]
Parameter Type Description
shards Array A list of available shards.
storageComponentId String The UUID of the storage component associated with the listed shard(s).
path String The path or location where the shard(s) is stored on the system.

Return codes

Status code

HTTP name

Description

200 OK The request was executed successfully.
400 Bad Request Access was denied because the bucket and object names were invalid.
401 Unauthorized Access was denied because credentials are not valid.
404 Not Found The bucket and object were not found.
405 Method Not Allowed The specified HTTP method is not allowed for user data. Resend using POST.