Describe Storage Integration (V2)

This operation gets details of a bucket storage integration. The project scope is resolved from the integration ID.

GET/v2/storageIntegrations/{integrationId}

Connection Endpoint

The base URL for this API is in the following format:

https://api.cloud.zilliz.com

📘Notes

The endpoints on the control plane currently supports up to 20 requests per second per user per endpoint.

export BASE_URL="https://api.cloud.zilliz.com"

Parameters

Authorizationstringheaderrequired

The authentication token should be an API key with appropriate privileges.

Example Value: Bearer {{TOKEN}}

integrationIdstringpathrequired

The ID of the storage integration.

Example Value: integ-xxxxxxxxxxxxxxxxxxx

export TOKEN="YOUR_API_KEY"
export integrationId="integ-xxxxxxxxxxxxxxxxxxx"

curl --request GET \
--url "${BASE_URL}/v2/storageIntegrations/${integrationId}" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json"

Responses200 - application/json

SUCCESS

A success response.

codeinteger

Response code.

Example Value: 0

dataundefined

(To be added soon)

FAILURE

A failure response.

codeinteger

Response code.

Example Value: 1800

messagestring

Error message.

Example Value: User hasn't authenticated

SUCCESS

{
    "code": 0,
    "data": {
        "integrationId": "integ-xxxxxxxxxxxxxxxxxxx",
        "name": "analytics-s3",
        "description": "S3 bucket for external tables",
        "status": "ACTIVE",
        "message": "",
        "regionId": "aws-us-west-2",
        "bucketName": "my-bucket",
        "externalCred": {
            "roleArn": "arn:aws:iam::123456789012:role/zilliz-bucket-role",
            "externalId": "zilliz-external-AbCdEf12345678"
        },
        "createTime": "2024-07-30T16:49:50Z"
    }
}

FAILURE

{
    "code": 1800,
    "message": "User hasn't authenticated"
}