Open Context Protocol is live! 🚀 Read the launch post
getObjectStorage

getObjectStorage

Get Object Storage

Details

  • Method: GET
  • Path: /object-storage/{object-storage-id}
  • Operation ID: get-object-storage

Parameters

{}

Response Schema

{
  "type": "object",
  "properties": {
    "object_storage": {
      "title": "object-storage",
      "type": "object",
      "x-tags": [
        "s3"
      ],
      "x-examples": {
        "object storage": {
          "id": "cb676a46-66fd-4dfb-b839-443f2e6c0b60",
          "date_created": "2020-10-10T01:56:20+00:00",
          "cluster_id": 2,
          "region": "ewr",
          "label": "Example Object Storage",
          "status": "active",
          "s3_hostname": "ewr1.vultrobjects.com",
          "s3_access_key": "00example11223344",
          "s3_secret_key": "00example1122334455667788990011"
        }
      },
      "description": "Object Storage information.",
      "properties": {
        "id": {
          "type": "string",
          "description": "A unique ID for the Object Storage."
        },
        "date_created": {
          "type": "string",
          "description": "Date the Object Store was created."
        },
        "cluster_id": {
          "type": "integer",
          "description": "The [Cluster id](#operation/list-object-storage-clusters)."
        },
        "region": {
          "type": "string",
          "description": "The [Region id](#operation/list-regions) for this Object Storage."
        },
        "label": {
          "type": "string",
          "description": "The user-supplied label for this Object Storage."
        },
        "status": {
          "type": "string",
          "description": "The status of this Object Storage.\n\n* active\n* pending"
        },
        "s3_hostname": {
          "type": "string",
          "description": "The [Cluster hostname](#operation/list-object-storage-clusters) for this Object Storage."
        },
        "s3_access_key": {
          "type": "string",
          "description": "The Object Storage access key."
        },
        "s3_secret_key": {
          "type": "string",
          "description": "The Object Storage secret key."
        }
      }
    }
  }
}

Usage

from ocp_agent import OCPAgent

agent = OCPAgent()
await agent.register_api('vultr')

# Call this tool
result = await agent.call_tool('getObjectStorage', {
    # Add required parameters here
})