List storage components

The method storage_component/list retrieves a list of all storage components created in the HCP for cloud scale system along with their component settings.

HTTP request syntax (URI)

POST https://host_ip:9099/mapi/v1/storage_component/list

Request structure

Not applicable.

Response structure

The response body is:

[
  {
    "id": "uuid",
    "storageType": "enum",
    "storageComponentConfig": {
      "label": "label",
      "host": "url",
      "https": true|false,
      "port": nnnnn,
      "bucket": "bucket_name",
      "region": "region_name",
      "authType": "V2|V4",
      "siteAffiliation": {
        "id": "uuid"
      },
      "useProxy": true|false,
      "proxyHost": "host_name",
      "proxyPort": nnnnn,
      "proxyUserName": "user_name",
      "proxyPassword": "password",
      "proxyDomain": "domain_name",
      "usePathStyleAlways": true|false,
      "connectionTimeout": ms,
      "socketTimeout": ms,
      "connectionTTL": ms,
      "maxConnections": nnnnnnn,
      "userAgentPrefix": "prefix",
      "socketSendBufferSizeHint": nnnnnnn,
      "socketRecvBufferSizeHint": nnnnnnn,
      "managementProtocol": http|https,
      "managementHost": "host_name",
      "readOnly": true|false,
      "state": "state"
    }
  }
]

Parameter	Type	Description
id	UUID	The ID of the storage component.
storageType	Enum	The type of storage component: `AMAZON_S3`: An Amazon Web Services S3-compatible node `HCP_S3`: A Hitachi Content Platform node `HCPS_S3`: An HCP S Series Node `GENERIC_S3`: An S3-compatible node
storageComponentConfig	List	The following storage component configuration values:
label	String	The name of the storage component.
host	String	The URL of the storage component back-end host domain.
https	Boolean	`true` for HTTPS connection to back-end system, `false` for HTTP.
port	32-bit integer	HTTP port to back-end system.
bucket	String	The name of the bucket.
region	String	The S3 region.
authType	String	AWS Signature Version, used for authenticating all interactions with Amazon S3: `V2` `V4`
siteAffiliation	UUID	The value of `id`, a UUID representing the storage component or the user.
useProxy	Boolean	If `true`, a proxy server is defined. If `false`, a proxy server is not defined.
proxyHost	String	The proxy host, if used; otherwise, `null`.
proxyPort	32-bit integer	The proxy port number, if used; otherwise, `null`.
proxyUserName	String	The proxy domain user name, if used; otherwise, `null`.
proxyPassword	String	The proxy domain password, if used; otherwise, `null`.
proxyDomain	String	The proxy domain, if used; otherwise, `null`.
usePathStyleAlways	Boolean	If `true`, use path-style syntax to send requests to the back-end system; if `false`, use virtual-hosted style.
connectionTimeout	32-bit integer	The amount of time, in milliseconds, that the HTTP connection waits to establish a connection before timing out.
socketTimeout	32-bit integer	The timeout value for reading from a connected socket.
connectionTTL	64-bit integer	The connection time to live (TTL) for a request.
maxConnections	32-bit integer	The maximum number of open HTTP connections to a storage component.
userAgentPrefix	String	The HTTP user agent prefix header, used in requests to a storage component.
socketSendBufferSizeHint	32-bit integer	The size hint, in bytes, for the low-level TCP send buffer.
socketRecvBufferSizeHint	32-bit integer	The size hint, in bytes, for the low-level TCP receive buffer.
managementProtocol	String	The communication protocol for HCP S Series Node MAPI requests: `http` `https`
managementHost	String	The host managing an HCP S Series Node storage component.
readOnly	Boolean	If `true`, the storage component is marked as read-only. If `false`, the storage component is available for reading and writing data.
state	Enum	The state of the storage component, indicating its availability to serve requests: `ACTIVE`: The storage component is ready for requests. `INACTIVE`: The storage component is on an administrative pause. `INACCESSIBLE`: The storage component is not accessible. This can be caused by network, authentication, or certificate errors. `UNVERIFIED`: The storage component has not been activated or has failed to activate.

Return codes

Status code	HTTP name	Description
200	OK	The request was executed successfully.
401	Unauthorized	Access was denied because credentials are not valid.
405	Method Not Allowed	The specified HTTP method is not allowed for a storage component. Resend using POST.

Example

Request example:

POST https://10.10.24.195:9099/mapi/v1/storage_component/list

JSON response:

[
  {
    "id": "8bff981b-5894-43ce-bd41-5a6f548cc241",
    "storageType": "GENERIC_S3",
    "storageComponentConfig": {
      "label": null,
      "host": "172.19.54.102",
      "https": false,
      "port": 9000,
      "bucket": "samplebucket",
      "region": "us-west-2",
      "authType": null,
      "siteAffiliation": {
        "id": "19b96ae2-38dd-4686-b298-b5bebe173e96"
      },
      "useProxy": false,
      "proxyHost": null,
      "proxyPort": null,
      "proxyUserName": null,
      "proxyPassword": null,
      "proxyDomain": null,
      "usePathStyleAlways": true,
      "connectionTimeout": null,
      "socketTimeout": null,
      "connectionTTL": null,
      "maxConnections": 50,
      "userAgentPrefix": null,
      "socketSendBufferSizeHint": null,
      "socketRecvBufferSizeHint": null,
      "managementProtocol": null,
      "managementHost": null,
      "readOnly": false,
      "state": "ACTIVE"
    }
  }
]