Fetch existing CVFS S3 Bucket details

Select

SaaS

Customer Managed

Fetches the details of the given CVFS bucket

Path Parameters

• id int32 required

  ID of the bucket

Responses

• 200
• 404
• 500

---

Success

application/json

• Schema
• Example (from schema)

---

Schema

• id int32

  The ID of the bucket

• name string

  The name of bucket

• endPointURL string

  The URL of bucket

• spaceUsage string

  amount of space used in GB

• objectCount int32

  the count of the number of objects in the bucket

• compressionRatio float

  the present compression ratio of the bucket

• versioning string

  Possible values: [UNVERSIONED, ENABLED, SUSPENDED]

  To enable/suspend the versioning on the CVFS S3 bucket

• bucketSize string

  Possible values: Value must match regular expression ^\d+\s(GB)$

  The size of the bucket in GB

{
  "id": 0,
  "name": "string",
  "endPointURL": "string",
  "spaceUsage": "string",
  "objectCount": 0,
  "compressionRatio": 0,
  "versioning": "UNVERSIONED",
  "bucketSize": "string"
}

Requested bucket does not exist

application/json

• Schema
• Example (from schema)

---

Schema

• errorMessage string

  Tells about the error occured

• errorCode ErrorCode

  Possible values: [NO_ERROR, INVALID_INPUT, VALUE_NOT_FOUND, UNKNOWN_EXCEPTION, CONNECTION_PROBLEM, UNKNOWN_SQL_ERROR, INVALID_USER, INVALID_OPERATION_TYPE, INTERNAL_SERVER_PROBLEM, INSUFFICIENT_USER_PERMISSION_ON_ENTITY, INVALID_ENTITY_ID]

  Error code value

{
  "errorMessage": "string",
  "errorCode": "NO_ERROR"
}

Server Error

application/json

• Schema
• Example (from schema)

---

Schema

• errorMessage string

  Tells about the error occured

• errorCode ErrorCode

  Possible values: [NO_ERROR, INVALID_INPUT, VALUE_NOT_FOUND, UNKNOWN_EXCEPTION, CONNECTION_PROBLEM, UNKNOWN_SQL_ERROR, INVALID_USER, INVALID_OPERATION_TYPE, INTERNAL_SERVER_PROBLEM, INSUFFICIENT_USER_PERMISSION_ON_ENTITY, INVALID_ENTITY_ID]

  Error code value

{
  "errorMessage": "string",
  "errorCode": "NO_ERROR"
}

Loading...