Displaying stored segments

Virtual Storage Platform One Object Management API Reference Guide

Version
3.3.x
File Size
137 KB
Audience
anonymous
Part Number
MK-24VSP1OB002-04
ft:lastEdition
2026-05-14
post /v1/client_object/lookup

Provides a list of all of the stored segments on a system. This call is reserved for Hitachi Vantara support and should not be used.

Request headers
X-XSRF-TOKEN String required

XSRF token header for CSRF security. Can be obtained as the value of a cookie by performing a GET on /csrf.

Example: xXSRFTOKEN_example
Cookie String required

XSRF token header for CSRF security. Can be obtained as the value of a cookie by performing a GET on /csrf.

Example: cookie_example
CLIENT REQUEST
curl -X 'POST'
-H 'Accept: application/json'
-H 'X-XSRF-TOKEN: xXSRFTOKEN_example' -H 'Cookie: cookie_example'
'http://localhost/v1/client_object/lookup'
-d '{ "bucketName" : "bucketName", "objectName" : "objectName" }'
import http.client conn = http.client.HTTPConnection("undefinedundefined") headers = { 'X-XSRF-TOKEN': "SOME_STRING_VALUE", 'Cookie': "SOME_STRING_VALUE" } conn.request("POST", "/v1/client_object/lookup", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
require 'uri' require 'net/http' url = URI("http://undefinedundefined/v1/client_object/lookup") http = Net::HTTP.new(url.host, url.port) request = Net::HTTP::Post.new(url) request["X-XSRF-TOKEN"] = 'SOME_STRING_VALUE' request["Cookie"] = 'SOME_STRING_VALUE' response = http.request(request) puts response.read_body
const data = null; const xhr = new XMLHttpRequest(); xhr.withCredentials = true; xhr.addEventListener("readystatechange", function () { if (this.readyState === this.DONE) { console.log(this.responseText); } }); xhr.open("POST", "http://undefinedundefined/v1/client_object/lookup"); xhr.setRequestHeader("X-XSRF-TOKEN", "SOME_STRING_VALUE"); xhr.setRequestHeader("Cookie", "SOME_STRING_VALUE"); xhr.send(data);
HttpResponse<String> response = Unirest.post("http://undefinedundefined/v1/client_object/lookup") .header("X-XSRF-TOKEN", "SOME_STRING_VALUE") .header("Cookie", "SOME_STRING_VALUE") .asString();
import Foundation let headers = [ "X-XSRF-TOKEN": "SOME_STRING_VALUE", "Cookie": "SOME_STRING_VALUE" ] let request = NSMutableURLRequest(url: NSURL(string: "http://undefinedundefined/v1/client_object/lookup")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume()
<?php $curl = curl_init(); curl_setopt_array($curl, [ CURLOPT_URL => "http://undefinedundefined/v1/client_object/lookup", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_HTTPHEADER => [ "Cookie: SOME_STRING_VALUE", "X-XSRF-TOKEN: SOME_STRING_VALUE" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; }
CURL *hnd = curl_easy_init(); curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST"); curl_easy_setopt(hnd, CURLOPT_URL, "http://undefinedundefined/v1/client_object/lookup"); struct curl_slist *headers = NULL; headers = curl_slist_append(headers, "X-XSRF-TOKEN: SOME_STRING_VALUE"); headers = curl_slist_append(headers, "Cookie: SOME_STRING_VALUE"); curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers); CURLcode ret = curl_easy_perform(hnd);
var client = new RestClient("http://undefinedundefined/v1/client_object/lookup"); var request = new RestRequest(Method.POST); request.AddHeader("X-XSRF-TOKEN", "SOME_STRING_VALUE"); request.AddHeader("Cookie", "SOME_STRING_VALUE"); IRestResponse response = client.Execute(request);
Body parameters
required
*/*
bucketNamestringrequired

The name of the bucket that stores the object in the storage component

objectNamestringrequired

The name of the object to look up

REQUEST
[*/* content]
Responses

The segment lookup ran successfully.

Body
application/json
[
shardsarray

Shards comprising a stored object

[
storageComponentIdintegerrequired

The storage component that stores the object

pathstringrequired

Object file path

]
]
RESPONSE
[ { "shards": [ { "storageComponentId": 0, "path": "example" } ] } ]

The request was missing valid parameters. A valid bucketName and objectName are required.

Body
application/json
codestring

Error code

messagestring

Error message

detailsstring

Error details

RESPONSE
{ "code": "example", "message": "example", "details": "example" }

Access was denied due to invalid credentials.

The requested metadata was not found.

Body
application/json
codestring

Error code

messagestring

Error message

detailsstring

Error details

RESPONSE
{ "code": "example", "message": "example", "details": "example" }

The specified HTTP method is not allowed. Please resend the request using the POST method.