IBM Cloud API Docs

Introduction

Last updated: 2023-07-10

IBM® watsonx.data is a data management solution for collecting, storing, querying, and analyzing all your enterprise data (structured, semi-structured, and unstructured) with a single unified data platform. It provides a flexible and reliable platform that is optimized to work on open data formats.

The api are in beta state and expected to change.

Endpoint URLs

The base URLs come from the service instance. To find the URL, view the service credentials by clicking the name of the service in the Resource list. Use the value of the URL. Add the method to form the complete API endpoint for your request.

Authentication

Required Purpose: To work with the API, you must use an IBM Cloud Identity and Access Management (IAM) access token. The token is used to determine the actions that a user or service ID has access to when they use the API.

You can generate an IAM token for an authenticated user or service ID by using the IAM Identity Services API. IAM tokens are generated by using the user or service ID's API key. For more information, see Generating an IBM Cloud IAM token by using an API key.

To use the API, add a valid IAM token to the HTTP Authorization request header, for example, -H 'Authorization: Bearer {TOKEN}'.

To retrieve your access token:

curl -X POST   "https://iam.cloud.ibm.com/identity/token"   --header 'Content-Type: application/x-www-form-urlencoded'   --header 'Accept: application/json'   --data-urlencode 'grant_type=urn:ibm:params:oauth:grant-type:apikey'   --data-urlencode 'apikey={API_KEY}'

Replace {API_KEY} with your IAM API key.

Auditing

Required if applicable Purpose: Describes that the API generates auditing events that can be consumed by the Activity Tracker service, and links to your related product docs for more information. Required only if any of the API's methods is enabled to generate auditing events.

Example:

You can monitor API activity within your account by using the IBM Cloud Activity Tracker service. Whenever an API method is called, an event is generated that you can then track and audit from within Activity Tracker. The specific event type is listed for each individual method.

For more information about how to track Certificate Manager activity, see Auditing events for Certificate Manager.

Error handling

This API uses standard HTTP response codes to indicate whether a method completed successfully. A 200 response indicates success. A 400 type response indicates a failure, and a 500 type response indicates an internal system error.

HTTP Error Code Description Recovery
200 Success The request was successful.
201 Created The requested resource successfully created in a synchronous manner.
204 No Content The server successfully processed the request and is not returning any content.
400 Bad Request The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request.
401 Unauthorized You are not authorized to make this request. Log in to IBM Cloud and try again. If this error persists, contact the account owner to check your permissions.
403 Forbidden The supplied authentication is not authorized to access '{namespace}'.
404 Not Found The requested resource could not be found.
409 Conflict The entity is already in the requested state.
500 Internal Server Error Your request could not be processed. Wait a few minutes and try again.

Pagination

Some API requests might return many results. To avoid performance issues, these results are returned one page at a time, with a limited number of results on each page. GET requests for the following resources use pagination:

  • /v1/statement

For the request that uses pagination, the response does include following urls to make subsequent requests :

  • infoUri: The URL for requesting the first page of results.
  • nextUri: The URL for requesting the next page of results.

Methods

Get bucket registrations

Get list of registered buckets

Get list of registered buckets.

Get list of registered buckets.

Get list of registered buckets.

Get list of registered buckets.

GET /bucket_registrations
(watsonxData *WatsonxDataV2) ListBucketRegistrations(listBucketRegistrationsOptions *ListBucketRegistrationsOptions) (result *BucketRegistrationCollection, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) ListBucketRegistrationsWithContext(ctx context.Context, listBucketRegistrationsOptions *ListBucketRegistrationsOptions) (result *BucketRegistrationCollection, response *core.DetailedResponse, err error)
ServiceCall<BucketRegistrationCollection> listBucketRegistrations(ListBucketRegistrationsOptions listBucketRegistrationsOptions)
list_bucket_registrations(
        self,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
listBucketRegistrations(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.bucket_registration.list

Request

Instantiate the ListBucketRegistrationsOptions struct and set the fields to provide parameter values for the ListBucketRegistrations method.

Use the ListBucketRegistrationsOptions.Builder to create a ListBucketRegistrationsOptions object that contains the parameter values for the listBucketRegistrations method.

Custom Headers

  • AuthInstanceId
    string

    CRN

    Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9:/-]+$

parameter

WithContext method only

ListBucketRegistrationsOptions

The ListBucketRegistrations options.

ListBucketRegistrationsOptions

The listBucketRegistrations options.

parameters

  • auth_instance_id
    str

    Instance ID.

    Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9:\/-]+$/

parameters

  • authInstanceId
    string

    Instance ID.

    Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9:\/-]+$/

  • curl -X GET -H "accept: application/json" -H "AuthInstanceId: {CRN}" "https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/bucket_registrations"
  • listBucketRegistrationsOptions := watsonxDataService.NewListBucketRegistrationsOptions()

bucketRegistrationCollection, response, err := watsonxDataService.ListBucketRegistrations(listBucketRegistrationsOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(bucketRegistrationCollection, "", "  ")
fmt.Println(string(b))
  • let res;
try {
  res = await watsonxDataService.listBucketRegistrations({});
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
  • ListBucketRegistrationsOptions listBucketRegistrationsOptions = new ListBucketRegistrationsOptions.Builder()
  .build();

Response<BucketRegistrationCollection> response = watsonxDataService.listBucketRegistrations(listBucketRegistrationsOptions).execute();
BucketRegistrationCollection bucketRegistrationCollection = response.getResult();

System.out.println(bucketRegistrationCollection);
  • response = watsonx_data_service.list_bucket_registrations()
bucket_registration_collection = response.get_result()

print(json.dumps(bucket_registration_collection, indent=2))

Response

Response Body

BucketRegistrationCollection

List bucket registrations

BucketRegistrationCollection

List bucket registrations.

Examples: 
{
  "bucket_registrations": [
    {
      "actions": [
        "browse",
        "view",
        "modify",
        "create",
        "grant",
        "revoke",
        "update",
        "remove",
        "activate",
        "register"
      ],
      "associated_catalog": {
        "catalog_name": "iceberg_catalog",
        "catalog_tags": []
      },
      "bucket_details": {
        "bucket_name": "iceberg-bucket",
        "endpoint": "http://xyz-minio-svc:9000"
      },
      "bucket_display_name": "hive-bucket",
      "bucket_id": "iceberg-bucket",
      "bucket_type": "minio",
      "created_by": "user",
      "created_on": "1699457595",
      "description": "default bucket",
      "managed_by": "ibm",
      "region": "us-south",
      "state": "active",
      "storage_details": {
        "container_name": "<container_name>",
        "storage_account_name": "<storage_account_name>",
        "endpoint": "abfss://<container_name>@<storage_account_name>.dfs.core.windows.net/",
        "auth_mode": "<auth_mode>"
      },
      "tags": [
        "tag1",
        "tag2"
      ]
    },
    {
      "actions": [
        "browse",
        "view",
        "modify",
        "create",
        "grant",
        "revoke",
        "update",
        "remove",
        "activate",
        "register"
      ],
      "associated_catalog": {
        "catalog_name": "hive_data",
        "catalog_tags": []
      },
      "bucket_details": {
        "bucket_name": "hive-bucket",
        "endpoint": "http://xyz-minio-svc:9000"
      },
      "bucket_display_name": "hive-bucket",
      "bucket_id": "hive-bucket",
      "bucket_type": "minio",
      "created_by": "user",
      "created_on": "1699457595",
      "description": "default bucket",
      "managed_by": "ibm",
      "region": "us-south",
      "state": "active",
      "storage_details": {
        "container_name": "<conatiner_name>",
        "storage_account_name": "<storage_account_name>",
        "endpoint": "abfss://<container_name>@<storage_account_name>.dfs.core.windows.net/",
        "auth_mode": "<auth_mode>"
      },
      "tags": [
        "tag1",
        "tag2"
      ]
    }
  ]
}

BucketRegistrationCollection

List bucket registrations.

Examples: 
{
  "bucket_registrations": [
    {
      "actions": [
        "browse",
        "view",
        "modify",
        "create",
        "grant",
        "revoke",
        "update",
        "remove",
        "activate",
        "register"
      ],
      "associated_catalog": {
        "catalog_name": "iceberg_catalog",
        "catalog_tags": []
      },
      "bucket_details": {
        "bucket_name": "iceberg-bucket",
        "endpoint": "http://xyz-minio-svc:9000"
      },
      "bucket_display_name": "hive-bucket",
      "bucket_id": "iceberg-bucket",
      "bucket_type": "minio",
      "created_by": "user",
      "created_on": "1699457595",
      "description": "default bucket",
      "managed_by": "ibm",
      "region": "us-south",
      "state": "active",
      "storage_details": {
        "container_name": "<container_name>",
        "storage_account_name": "<storage_account_name>",
        "endpoint": "abfss://<container_name>@<storage_account_name>.dfs.core.windows.net/",
        "auth_mode": "<auth_mode>"
      },
      "tags": [
        "tag1",
        "tag2"
      ]
    },
    {
      "actions": [
        "browse",
        "view",
        "modify",
        "create",
        "grant",
        "revoke",
        "update",
        "remove",
        "activate",
        "register"
      ],
      "associated_catalog": {
        "catalog_name": "hive_data",
        "catalog_tags": []
      },
      "bucket_details": {
        "bucket_name": "hive-bucket",
        "endpoint": "http://xyz-minio-svc:9000"
      },
      "bucket_display_name": "hive-bucket",
      "bucket_id": "hive-bucket",
      "bucket_type": "minio",
      "created_by": "user",
      "created_on": "1699457595",
      "description": "default bucket",
      "managed_by": "ibm",
      "region": "us-south",
      "state": "active",
      "storage_details": {
        "container_name": "<conatiner_name>",
        "storage_account_name": "<storage_account_name>",
        "endpoint": "abfss://<container_name>@<storage_account_name>.dfs.core.windows.net/",
        "auth_mode": "<auth_mode>"
      },
      "tags": [
        "tag1",
        "tag2"
      ]
    }
  ]
}

BucketRegistrationCollection

List bucket registrations.

Examples: 
{
  "bucket_registrations": [
    {
      "actions": [
        "browse",
        "view",
        "modify",
        "create",
        "grant",
        "revoke",
        "update",
        "remove",
        "activate",
        "register"
      ],
      "associated_catalog": {
        "catalog_name": "iceberg_catalog",
        "catalog_tags": []
      },
      "bucket_details": {
        "bucket_name": "iceberg-bucket",
        "endpoint": "http://xyz-minio-svc:9000"
      },
      "bucket_display_name": "hive-bucket",
      "bucket_id": "iceberg-bucket",
      "bucket_type": "minio",
      "created_by": "user",
      "created_on": "1699457595",
      "description": "default bucket",
      "managed_by": "ibm",
      "region": "us-south",
      "state": "active",
      "storage_details": {
        "container_name": "<container_name>",
        "storage_account_name": "<storage_account_name>",
        "endpoint": "abfss://<container_name>@<storage_account_name>.dfs.core.windows.net/",
        "auth_mode": "<auth_mode>"
      },
      "tags": [
        "tag1",
        "tag2"
      ]
    },
    {
      "actions": [
        "browse",
        "view",
        "modify",
        "create",
        "grant",
        "revoke",
        "update",
        "remove",
        "activate",
        "register"
      ],
      "associated_catalog": {
        "catalog_name": "hive_data",
        "catalog_tags": []
      },
      "bucket_details": {
        "bucket_name": "hive-bucket",
        "endpoint": "http://xyz-minio-svc:9000"
      },
      "bucket_display_name": "hive-bucket",
      "bucket_id": "hive-bucket",
      "bucket_type": "minio",
      "created_by": "user",
      "created_on": "1699457595",
      "description": "default bucket",
      "managed_by": "ibm",
      "region": "us-south",
      "state": "active",
      "storage_details": {
        "container_name": "<conatiner_name>",
        "storage_account_name": "<storage_account_name>",
        "endpoint": "abfss://<container_name>@<storage_account_name>.dfs.core.windows.net/",
        "auth_mode": "<auth_mode>"
      },
      "tags": [
        "tag1",
        "tag2"
      ]
    }
  ]
}

BucketRegistrationCollection

List bucket registrations.

Examples: 
{
  "bucket_registrations": [
    {
      "actions": [
        "browse",
        "view",
        "modify",
        "create",
        "grant",
        "revoke",
        "update",
        "remove",
        "activate",
        "register"
      ],
      "associated_catalog": {
        "catalog_name": "iceberg_catalog",
        "catalog_tags": []
      },
      "bucket_details": {
        "bucket_name": "iceberg-bucket",
        "endpoint": "http://xyz-minio-svc:9000"
      },
      "bucket_display_name": "hive-bucket",
      "bucket_id": "iceberg-bucket",
      "bucket_type": "minio",
      "created_by": "user",
      "created_on": "1699457595",
      "description": "default bucket",
      "managed_by": "ibm",
      "region": "us-south",
      "state": "active",
      "storage_details": {
        "container_name": "<container_name>",
        "storage_account_name": "<storage_account_name>",
        "endpoint": "abfss://<container_name>@<storage_account_name>.dfs.core.windows.net/",
        "auth_mode": "<auth_mode>"
      },
      "tags": [
        "tag1",
        "tag2"
      ]
    },
    {
      "actions": [
        "browse",
        "view",
        "modify",
        "create",
        "grant",
        "revoke",
        "update",
        "remove",
        "activate",
        "register"
      ],
      "associated_catalog": {
        "catalog_name": "hive_data",
        "catalog_tags": []
      },
      "bucket_details": {
        "bucket_name": "hive-bucket",
        "endpoint": "http://xyz-minio-svc:9000"
      },
      "bucket_display_name": "hive-bucket",
      "bucket_id": "hive-bucket",
      "bucket_type": "minio",
      "created_by": "user",
      "created_on": "1699457595",
      "description": "default bucket",
      "managed_by": "ibm",
      "region": "us-south",
      "state": "active",
      "storage_details": {
        "container_name": "<conatiner_name>",
        "storage_account_name": "<storage_account_name>",
        "endpoint": "abfss://<container_name>@<storage_account_name>.dfs.core.windows.net/",
        "auth_mode": "<auth_mode>"
      },
      "tags": [
        "tag1",
        "tag2"
      ]
    }
  ]
}

Status Code

  • 200

    Success

  • 400

    Error

  • 401

    Unauthorized

  • 404

    Not found

  • 500

    Internal server error

Example responses
  • {
  "bucket_registrations": [
    {
      "actions": [
        "browse",
        "view",
        "modify",
        "create",
        "grant",
        "revoke",
        "update",
        "remove",
        "activate",
        "register"
      ],
      "associated_catalog": {
        "catalog_name": "iceberg_catalog",
        "catalog_tags": []
      },
      "bucket_details": {
        "bucket_name": "iceberg-bucket",
        "endpoint": "http://xyz-minio-svc:9000"
      },
      "bucket_display_name": "hive-bucket",
      "bucket_id": "iceberg-bucket",
      "bucket_type": "minio",
      "created_by": "user",
      "created_on": "1699457595",
      "description": "default bucket",
      "managed_by": "ibm",
      "region": "us-south",
      "state": "active",
      "storage_details": {
        "container_name": "<container_name>",
        "storage_account_name": "<storage_account_name>",
        "endpoint": "abfss://<container_name>@<storage_account_name>.dfs.core.windows.net/",
        "auth_mode": "<auth_mode>"
      },
      "tags": [
        "tag1",
        "tag2"
      ]
    },
    {
      "actions": [
        "browse",
        "view",
        "modify",
        "create",
        "grant",
        "revoke",
        "update",
        "remove",
        "activate",
        "register"
      ],
      "associated_catalog": {
        "catalog_name": "hive_data",
        "catalog_tags": []
      },
      "bucket_details": {
        "bucket_name": "hive-bucket",
        "endpoint": "http://xyz-minio-svc:9000"
      },
      "bucket_display_name": "hive-bucket",
      "bucket_id": "hive-bucket",
      "bucket_type": "minio",
      "created_by": "user",
      "created_on": "1699457595",
      "description": "default bucket",
      "managed_by": "ibm",
      "region": "us-south",
      "state": "active",
      "storage_details": {
        "container_name": "<conatiner_name>",
        "storage_account_name": "<storage_account_name>",
        "endpoint": "abfss://<container_name>@<storage_account_name>.dfs.core.windows.net/",
        "auth_mode": "<auth_mode>"
      },
      "tags": [
        "tag1",
        "tag2"
      ]
    }
  ]
}
  • {
  "bucket_registrations": [
    {
      "actions": [
        "browse",
        "view",
        "modify",
        "create",
        "grant",
        "revoke",
        "update",
        "remove",
        "activate",
        "register"
      ],
      "associated_catalog": {
        "catalog_name": "iceberg_catalog",
        "catalog_tags": []
      },
      "bucket_details": {
        "bucket_name": "iceberg-bucket",
        "endpoint": "http://xyz-minio-svc:9000"
      },
      "bucket_display_name": "hive-bucket",
      "bucket_id": "iceberg-bucket",
      "bucket_type": "minio",
      "created_by": "user",
      "created_on": "1699457595",
      "description": "default bucket",
      "managed_by": "ibm",
      "region": "us-south",
      "state": "active",
      "storage_details": {
        "container_name": "<container_name>",
        "storage_account_name": "<storage_account_name>",
        "endpoint": "abfss://<container_name>@<storage_account_name>.dfs.core.windows.net/",
        "auth_mode": "<auth_mode>"
      },
      "tags": [
        "tag1",
        "tag2"
      ]
    },
    {
      "actions": [
        "browse",
        "view",
        "modify",
        "create",
        "grant",
        "revoke",
        "update",
        "remove",
        "activate",
        "register"
      ],
      "associated_catalog": {
        "catalog_name": "hive_data",
        "catalog_tags": []
      },
      "bucket_details": {
        "bucket_name": "hive-bucket",
        "endpoint": "http://xyz-minio-svc:9000"
      },
      "bucket_display_name": "hive-bucket",
      "bucket_id": "hive-bucket",
      "bucket_type": "minio",
      "created_by": "user",
      "created_on": "1699457595",
      "description": "default bucket",
      "managed_by": "ibm",
      "region": "us-south",
      "state": "active",
      "storage_details": {
        "container_name": "<conatiner_name>",
        "storage_account_name": "<storage_account_name>",
        "endpoint": "abfss://<container_name>@<storage_account_name>.dfs.core.windows.net/",
        "auth_mode": "<auth_mode>"
      },
      "tags": [
        "tag1",
        "tag2"
      ]
    }
  ]
}

Register bucket

Register a new bucket

Register a new bucket.

Register a new bucket.

Register a new bucket.

Register a new bucket.

POST /bucket_registrations
(watsonxData *WatsonxDataV2) CreateBucketRegistration(createBucketRegistrationOptions *CreateBucketRegistrationOptions) (result *BucketRegistration, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) CreateBucketRegistrationWithContext(ctx context.Context, createBucketRegistrationOptions *CreateBucketRegistrationOptions) (result *BucketRegistration, response *core.DetailedResponse, err error)
ServiceCall<BucketRegistration> createBucketRegistration(CreateBucketRegistrationOptions createBucketRegistrationOptions)
create_bucket_registration(
        self,
        bucket_type: str,
        description: str,
        managed_by: str,
        *,
        associated_catalog: Optional['BucketCatalog'] = None,
        bucket_details: Optional['BucketDetails'] = None,
        bucket_display_name: Optional[str] = None,
        region: Optional[str] = None,
        storage_details: Optional['StorageDetails'] = None,
        tags: Optional[List[str]] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
createBucketRegistration(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.bucket_registration.create

Request

Instantiate the CreateBucketRegistrationOptions struct and set the fields to provide parameter values for the CreateBucketRegistration method.

Use the CreateBucketRegistrationOptions.Builder to create a CreateBucketRegistrationOptions object that contains the parameter values for the createBucketRegistration method.

Custom Headers

  • AuthInstanceId
    string

    CRN

    Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9:/-]+$

Request Body

Required*
BucketRegistrationPrototype

Request body

parameter

WithContext method only

CreateBucketRegistrationOptions

The CreateBucketRegistration options.

CreateBucketRegistrationOptions

The createBucketRegistration options.

parameters

  • bucket_type
    Required*
    str

    bucket type.

    Allowable values: [aws_s3,minio,ibm_cos,ibm_ceph,adls_gen1,adls_gen2,google_cs]

    Possible values: 1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-_]+/

    Examples: 
  • description
    Required*
    str
    bucket description.
    

    Possible values:  0 ≤ length ≤ 50, Value must match regular expression /.*/
    Examples:  
  • managed_by
    Required*
    str
    managed by.
    

    Allowable values: [ibm,customer]
    Possible values:  1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9.@<>\\-]+/
    Examples:  
  • associated_catalog
    bucket catalog.
    

    Examples:  
    {
  "catalog_name": "iceberg_catalog",
  "catalog_tags": [
    "catalog_tag_1",
    "catalog_tag_2"
  ],
  "catalog_type": "iceberg"
}
  • bucket_details
    bucket details.
    

  • bucket_display_name
    str
    bucket display name.
    

    Possible values:  3 ≤ length ≤ 63, Value must match regular expression /.*/
    Examples:  
  • region
    str
    region where the bucket is located.
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
    Examples:  
  • storage_details
    storage details.
    

  • tags
    List[str]
    tags.
    

    Possible values:  0 ≤ number of items ≤ 10000, 1 ≤ length ≤ 1024, Value must match regular expression /.*/
    Examples:  
  • auth_instance_id
    str
    Instance ID.
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9:\/-]+$/
parameters
  • bucketType
    Required*
    string
    bucket type.
    

    Allowable values: [aws_s3,minio,ibm_cos,ibm_ceph,adls_gen1,adls_gen2,google_cs]
    Possible values:  1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-_]+/
    Examples:  
  • description
    Required*
    string
    bucket description.
    

    Possible values:  0 ≤ length ≤ 50, Value must match regular expression /.*/
    Examples:  
  • managedBy
    Required*
    string
    managed by.
    

    Allowable values: [ibm,customer]
    Possible values:  1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9.@<>\\-]+/
    Examples:  
  • associatedCatalog
    bucket catalog.
    

    Examples:  
    {
  "catalog_name": "iceberg_catalog",
  "catalog_tags": [
    "catalog_tag_1",
    "catalog_tag_2"
  ],
  "catalog_type": "iceberg"
}
  • bucketDetails
    bucket details.
    

  • bucketDisplayName
    string
    bucket display name.
    

    Possible values:  3 ≤ length ≤ 63, Value must match regular expression /.*/
    Examples:  
  • region
    string
    region where the bucket is located.
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
    Examples:  
  • storageDetails
    storage details.
    

  • tags
    string[]
    tags.
    

    Possible values:  0 ≤ number of items ≤ 10000, 1 ≤ length ≤ 1024, Value must match regular expression /.*/
    Examples:  
  • authInstanceId
    string
    Instance ID.
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9:\/-]+$/
  • curl -X POST -H "accept: application/json" -H "AuthInstanceId: {CRN}" -H "Content-Type: application/json" -d '{ "bucket_details": { "access_key": "<access_key>", "bucket_name": "sample-bucket", "endpoint": "https://s3.{region}.cloud-object-storage.appdomain.cloud/", "secret_key": "secret_key" }, "bucket_display_name": "sample-bucket-displayname", "bucket_tags": [ "read customer data", "write customer data'" ], "bucket_type": "ibm_cos", "catalog_name": "sampleCatalog", "catalog_tags": [ "catalog_tag_1", "catalog_tag_2" ], "description": "COS bucket for customer data", "managed_by": "ibm", "region": "us-south", "state": "active", "table_type": "iceberg" }' "https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/bucket_registrations"
  • createBucketRegistrationOptions := watsonxDataService.NewCreateBucketRegistrationOptions(
  "ibm_cos",
  "COS bucket for customer data",
  "ibm",
)

bucketRegistration, response, err := watsonxDataService.CreateBucketRegistration(createBucketRegistrationOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(bucketRegistration, "", "  ")
fmt.Println(string(b))
  • const params = {
  bucketType: 'ibm_cos',
  description: 'COS bucket for customer data',
  managedBy: 'ibm',
};

let res;
try {
  res = await watsonxDataService.createBucketRegistration(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
  • CreateBucketRegistrationOptions createBucketRegistrationOptions = new CreateBucketRegistrationOptions.Builder()
  .bucketType("ibm_cos")
  .description("COS bucket for customer data")
  .managedBy("ibm")
  .build();

Response<BucketRegistration> response = watsonxDataService.createBucketRegistration(createBucketRegistrationOptions).execute();
BucketRegistration bucketRegistration = response.getResult();

System.out.println(bucketRegistration);
  • response = watsonx_data_service.create_bucket_registration(
  bucket_type='ibm_cos',
  description='COS bucket for customer data',
  managed_by='ibm',
)
bucket_registration = response.get_result()

print(json.dumps(bucket_registration, indent=2))
Response
Response Body
BucketRegistration
Bucket


BucketRegistration
Bucket.


Examples:  
{
  "actions": [
    "create",
    "update"
  ],
  "associated_catalog": {
    "catalog_name": "hive_data",
    "catalog_type": "hive"
  },
  "bucket_display_name": "samplebucketdisplayname",
  "bucket_id": "samplebucketid",
  "bucket_name": "samplebucket",
  "bucket_type": "minio",
  "created_by": "username@domain.com",
  "created_on": "1699457595",
  "description": "default bucket",
  "endpoint": "https://s3.<region>.cloud-object-storage.appdomain.cloud/",
  "managed_by": "ibm",
  "region": "us-south",
  "state": "active",
  "tags": [
    "tag1",
    "tag2"
  ]
}
BucketRegistration
Bucket.


Examples:  
{
  "actions": [
    "create",
    "update"
  ],
  "associated_catalog": {
    "catalog_name": "hive_data",
    "catalog_type": "hive"
  },
  "bucket_display_name": "samplebucketdisplayname",
  "bucket_id": "samplebucketid",
  "bucket_name": "samplebucket",
  "bucket_type": "minio",
  "created_by": "username@domain.com",
  "created_on": "1699457595",
  "description": "default bucket",
  "endpoint": "https://s3.<region>.cloud-object-storage.appdomain.cloud/",
  "managed_by": "ibm",
  "region": "us-south",
  "state": "active",
  "tags": [
    "tag1",
    "tag2"
  ]
}
BucketRegistration
Bucket.


Examples:  
{
  "actions": [
    "create",
    "update"
  ],
  "associated_catalog": {
    "catalog_name": "hive_data",
    "catalog_type": "hive"
  },
  "bucket_display_name": "samplebucketdisplayname",
  "bucket_id": "samplebucketid",
  "bucket_name": "samplebucket",
  "bucket_type": "minio",
  "created_by": "username@domain.com",
  "created_on": "1699457595",
  "description": "default bucket",
  "endpoint": "https://s3.<region>.cloud-object-storage.appdomain.cloud/",
  "managed_by": "ibm",
  "region": "us-south",
  "state": "active",
  "tags": [
    "tag1",
    "tag2"
  ]
}
BucketRegistration
Bucket.


Examples:  
{
  "actions": [
    "create",
    "update"
  ],
  "associated_catalog": {
    "catalog_name": "hive_data",
    "catalog_type": "hive"
  },
  "bucket_display_name": "samplebucketdisplayname",
  "bucket_id": "samplebucketid",
  "bucket_name": "samplebucket",
  "bucket_type": "minio",
  "created_by": "username@domain.com",
  "created_on": "1699457595",
  "description": "default bucket",
  "endpoint": "https://s3.<region>.cloud-object-storage.appdomain.cloud/",
  "managed_by": "ibm",
  "region": "us-south",
  "state": "active",
  "tags": [
    "tag1",
    "tag2"
  ]
}
Status Code
  • 201
    Success
    

  • 400
    Error
    

  • 401
    Unauthorized
    

  • 404
    Not found
    

  • 500
    Internal server error
    

Example responses
  • {
  "actions": [
    "create",
    "update"
  ],
  "associated_catalog": {
    "catalog_name": "hive_data",
    "catalog_type": "hive"
  },
  "bucket_display_name": "samplebucketdisplayname",
  "bucket_id": "samplebucketid",
  "bucket_name": "samplebucket",
  "bucket_type": "minio",
  "created_by": "username@domain.com",
  "created_on": "1699457595",
  "description": "default bucket",
  "endpoint": "https://s3.<region>.cloud-object-storage.appdomain.cloud/",
  "managed_by": "ibm",
  "region": "us-south",
  "state": "active",
  "tags": [
    "tag1",
    "tag2"
  ]
}
  • {
  "actions": [
    "create",
    "update"
  ],
  "associated_catalog": {
    "catalog_name": "hive_data",
    "catalog_type": "hive"
  },
  "bucket_display_name": "samplebucketdisplayname",
  "bucket_id": "samplebucketid",
  "bucket_name": "samplebucket",
  "bucket_type": "minio",
  "created_by": "username@domain.com",
  "created_on": "1699457595",
  "description": "default bucket",
  "endpoint": "https://s3.<region>.cloud-object-storage.appdomain.cloud/",
  "managed_by": "ibm",
  "region": "us-south",
  "state": "active",
  "tags": [
    "tag1",
    "tag2"
  ]
}
Get bucket
Get a registered bucket


Get a registered bucket.


Get a registered bucket.


Get a registered bucket.


Get a registered bucket.


GET /bucket_registrations/{bucket_id}
(watsonxData *WatsonxDataV2) GetBucketRegistration(getBucketRegistrationOptions *GetBucketRegistrationOptions) (result *BucketRegistration, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) GetBucketRegistrationWithContext(ctx context.Context, getBucketRegistrationOptions *GetBucketRegistrationOptions) (result *BucketRegistration, response *core.DetailedResponse, err error)
ServiceCall<BucketRegistration> getBucketRegistration(GetBucketRegistrationOptions getBucketRegistrationOptions)
get_bucket_registration(
        self,
        bucket_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
getBucketRegistration(params)
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.
  • lakehouse.dashboard.view
Request
Instantiate the GetBucketRegistrationOptions struct and set the fields to provide parameter values for the GetBucketRegistration method.
Use the GetBucketRegistrationOptions.Builder to create a GetBucketRegistrationOptions object that contains the parameter values for the getBucketRegistration method.
Custom Headers
  • AuthInstanceId
    string
    CRN
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$
Path Parameters
  • bucket_id
    Required*
    string
    bucket id
    

    Possible values:  1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+$
parameter
WithContext method only
GetBucketRegistrationOptions
The GetBucketRegistration options.


GetBucketRegistrationOptions
The getBucketRegistration options.


parameters
  • bucket_id
    Required*
    str
    bucket id.
    

    Possible values:  1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
  • auth_instance_id
    str
    CRN.
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/
parameters
  • bucketId
    Required*
    string
    bucket id.
    

    Possible values:  1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
  • authInstanceId
    string
    CRN.
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/
  • curl -X GET -H "accept: application/json" -H "AuthInstanceId: {CRN}" "https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/bucket_registrations/{bucket_id}"
  • getBucketRegistrationOptions := watsonxDataService.NewGetBucketRegistrationOptions(
  "testString",
)

bucketRegistration, response, err := watsonxDataService.GetBucketRegistration(getBucketRegistrationOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(bucketRegistration, "", "  ")
fmt.Println(string(b))
  • const params = {
  bucketId: 'testString',
};

let res;
try {
  res = await watsonxDataService.getBucketRegistration(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
  • GetBucketRegistrationOptions getBucketRegistrationOptions = new GetBucketRegistrationOptions.Builder()
  .bucketId("testString")
  .build();

Response<BucketRegistration> response = watsonxDataService.getBucketRegistration(getBucketRegistrationOptions).execute();
BucketRegistration bucketRegistration = response.getResult();

System.out.println(bucketRegistration);
  • response = watsonx_data_service.get_bucket_registration(
  bucket_id='testString',
)
bucket_registration = response.get_result()

print(json.dumps(bucket_registration, indent=2))
Response
Response Body
BucketRegistration
Bucket


BucketRegistration
Bucket.


Examples:  
{
  "actions": [
    "create",
    "update"
  ],
  "associated_catalog": {
    "catalog_name": "hive_data",
    "catalog_type": "hive"
  },
  "bucket_display_name": "samplebucketdisplayname",
  "bucket_id": "samplebucketid",
  "bucket_name": "samplebucket",
  "bucket_type": "minio",
  "created_by": "username@domain.com",
  "created_on": "1699457595",
  "description": "default bucket",
  "endpoint": "https://s3.<region>.cloud-object-storage.appdomain.cloud/",
  "managed_by": "ibm",
  "region": "us-south",
  "state": "active",
  "tags": [
    "tag1",
    "tag2"
  ]
}
BucketRegistration
Bucket.


Examples:  
{
  "actions": [
    "create",
    "update"
  ],
  "associated_catalog": {
    "catalog_name": "hive_data",
    "catalog_type": "hive"
  },
  "bucket_display_name": "samplebucketdisplayname",
  "bucket_id": "samplebucketid",
  "bucket_name": "samplebucket",
  "bucket_type": "minio",
  "created_by": "username@domain.com",
  "created_on": "1699457595",
  "description": "default bucket",
  "endpoint": "https://s3.<region>.cloud-object-storage.appdomain.cloud/",
  "managed_by": "ibm",
  "region": "us-south",
  "state": "active",
  "tags": [
    "tag1",
    "tag2"
  ]
}
BucketRegistration
Bucket.


Examples:  
{
  "actions": [
    "create",
    "update"
  ],
  "associated_catalog": {
    "catalog_name": "hive_data",
    "catalog_type": "hive"
  },
  "bucket_display_name": "samplebucketdisplayname",
  "bucket_id": "samplebucketid",
  "bucket_name": "samplebucket",
  "bucket_type": "minio",
  "created_by": "username@domain.com",
  "created_on": "1699457595",
  "description": "default bucket",
  "endpoint": "https://s3.<region>.cloud-object-storage.appdomain.cloud/",
  "managed_by": "ibm",
  "region": "us-south",
  "state": "active",
  "tags": [
    "tag1",
    "tag2"
  ]
}
BucketRegistration
Bucket.


Examples:  
{
  "actions": [
    "create",
    "update"
  ],
  "associated_catalog": {
    "catalog_name": "hive_data",
    "catalog_type": "hive"
  },
  "bucket_display_name": "samplebucketdisplayname",
  "bucket_id": "samplebucketid",
  "bucket_name": "samplebucket",
  "bucket_type": "minio",
  "created_by": "username@domain.com",
  "created_on": "1699457595",
  "description": "default bucket",
  "endpoint": "https://s3.<region>.cloud-object-storage.appdomain.cloud/",
  "managed_by": "ibm",
  "region": "us-south",
  "state": "active",
  "tags": [
    "tag1",
    "tag2"
  ]
}
Status Code
  • 200
    Success
    

  • 400
    Error
    

  • 401
    Unauthorized
    

  • 404
    Not found
    

  • 500
    Internal server error
    

Example responses
  • {
  "actions": [
    "create",
    "update"
  ],
  "associated_catalog": {
    "catalog_name": "hive_data",
    "catalog_type": "hive"
  },
  "bucket_display_name": "samplebucketdisplayname",
  "bucket_id": "samplebucketid",
  "bucket_name": "samplebucket",
  "bucket_type": "minio",
  "created_by": "username@domain.com",
  "created_on": "1699457595",
  "description": "default bucket",
  "endpoint": "https://s3.<region>.cloud-object-storage.appdomain.cloud/",
  "managed_by": "ibm",
  "region": "us-south",
  "state": "active",
  "tags": [
    "tag1",
    "tag2"
  ]
}
  • {
  "actions": [
    "create",
    "update"
  ],
  "associated_catalog": {
    "catalog_name": "hive_data",
    "catalog_type": "hive"
  },
  "bucket_display_name": "samplebucketdisplayname",
  "bucket_id": "samplebucketid",
  "bucket_name": "samplebucket",
  "bucket_type": "minio",
  "created_by": "username@domain.com",
  "created_on": "1699457595",
  "description": "default bucket",
  "endpoint": "https://s3.<region>.cloud-object-storage.appdomain.cloud/",
  "managed_by": "ibm",
  "region": "us-south",
  "state": "active",
  "tags": [
    "tag1",
    "tag2"
  ]
}
Deregister Bucket
Deregister a bucket


Deregister a bucket.


Deregister a bucket.


Deregister a bucket.


Deregister a bucket.


DELETE /bucket_registrations/{bucket_id}
(watsonxData *WatsonxDataV2) DeleteBucketRegistration(deleteBucketRegistrationOptions *DeleteBucketRegistrationOptions) (response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) DeleteBucketRegistrationWithContext(ctx context.Context, deleteBucketRegistrationOptions *DeleteBucketRegistrationOptions) (response *core.DetailedResponse, err error)
ServiceCall<Void> deleteBucketRegistration(DeleteBucketRegistrationOptions deleteBucketRegistrationOptions)
delete_bucket_registration(
        self,
        bucket_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
deleteBucketRegistration(params)
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.
  • lakehouse.dashboard.view
Request
Instantiate the DeleteBucketRegistrationOptions struct and set the fields to provide parameter values for the DeleteBucketRegistration method.
Use the DeleteBucketRegistrationOptions.Builder to create a DeleteBucketRegistrationOptions object that contains the parameter values for the deleteBucketRegistration method.
Custom Headers
  • AuthInstanceId
    string
    CRN
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$
Path Parameters
  • bucket_id
    Required*
    string
    bucket id
    

    Possible values:  1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+$
parameter
WithContext method only
DeleteBucketRegistrationOptions
The DeleteBucketRegistration options.


DeleteBucketRegistrationOptions
The deleteBucketRegistration options.


parameters
  • bucket_id
    Required*
    str
    bucket id.
    

    Possible values:  1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
  • auth_instance_id
    str
    CRN.
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/
parameters
  • bucketId
    Required*
    string
    bucket id.
    

    Possible values:  1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
  • authInstanceId
    string
    CRN.
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/
  • curl -X DELETE -H "accept:  */*" -H "AuthInstanceId: {CRN}" "https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/bucket_registrations/{bucket_id}"
  • deleteBucketRegistrationOptions := watsonxDataService.NewDeleteBucketRegistrationOptions(
  "testString",
)

response, err := watsonxDataService.DeleteBucketRegistration(deleteBucketRegistrationOptions)
if err != nil {
  panic(err)
}
if response.StatusCode != 204 {
  fmt.Printf("\nUnexpected response status code received from DeleteBucketRegistration(): %d\n", response.StatusCode)
}
  • const params = {
  bucketId: 'testString',
};

try {
  await watsonxDataService.deleteBucketRegistration(params);
} catch (err) {
  console.warn(err);
}
  • DeleteBucketRegistrationOptions deleteBucketRegistrationOptions = new DeleteBucketRegistrationOptions.Builder()
  .bucketId("testString")
  .build();

Response<Void> response = watsonxDataService.deleteBucketRegistration(deleteBucketRegistrationOptions).execute();
  • response = watsonx_data_service.delete_bucket_registration(
  bucket_id='testString',
)
Response
Status Code
  • 204
    No Content
    

  • 400
    Error
    

  • 401
    Unauthorized
    

  • 404
    Not found
    

  • 500
    Internal server error
    

No Sample Response
This method does not specify any sample responses.
Update bucket
Update bucket details & credentials


Update bucket details & credentials.


Update bucket details & credentials.


Update bucket details & credentials.


Update bucket details & credentials.


PATCH /bucket_registrations/{bucket_id}
(watsonxData *WatsonxDataV2) UpdateBucketRegistration(updateBucketRegistrationOptions *UpdateBucketRegistrationOptions) (result *BucketRegistration, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) UpdateBucketRegistrationWithContext(ctx context.Context, updateBucketRegistrationOptions *UpdateBucketRegistrationOptions) (result *BucketRegistration, response *core.DetailedResponse, err error)
ServiceCall<BucketRegistration> updateBucketRegistration(UpdateBucketRegistrationOptions updateBucketRegistrationOptions)
update_bucket_registration(
        self,
        bucket_id: str,
        body: 'BucketRegistrationPatch',
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
updateBucketRegistration(params)
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.
  • lakehouse.bucket_registration.update
Request
Instantiate the UpdateBucketRegistrationOptions struct and set the fields to provide parameter values for the UpdateBucketRegistration method.
Use the UpdateBucketRegistrationOptions.Builder to create a UpdateBucketRegistrationOptions object that contains the parameter values for the updateBucketRegistration method.
Custom Headers
  • AuthInstanceId
    string
    CRN
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9:/-]+$
Path Parameters
  • bucket_id
    Required*
    string
    bucket id
    

    Possible values:  1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+$
Request Body
Required*
application/merge-patch+jsonBucketRegistrationPatch
Request body


Examples:  
{
  "bucket_details": {
    "access_key": "<access_key>",
    "bucket_name": "sample-bucket",
    "endpoint": "https://s3.<region>.cloud-object-storage.appdomain.cloud/",
    "secret_key": "secret_key"
  },
  "bucket_display_name": "samplebucketdisplayname",
  "description": "COS bucket for customer data",
  "tags": [
    "testbucket",
    "userbucket"
  ]
}
parameter
WithContext method only
UpdateBucketRegistrationOptions
The UpdateBucketRegistration options.


UpdateBucketRegistrationOptions
The updateBucketRegistration options.


parameters
  • bucket_id
    Required*
    str
    bucket id.
    

    Possible values:  1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
  • body
    Update bucket parameters.
    

    Examples:  
    {
  "bucket_details": {
    "access_key": "<access_key>",
    "bucket_name": "sample-bucket",
    "endpoint": "https://s3.<region>.cloud-object-storage.appdomain.cloud/",
    "secret_key": "secret_key"
  },
  "bucket_display_name": "samplebucketdisplayname",
  "description": "COS bucket for customer data",
  "tags": [
    "testbucket",
    "userbucket"
  ]
}
  • auth_instance_id
    str
    Instance ID.
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9:\/-]+$/
parameters
  • bucketId
    Required*
    string
    bucket id.
    

    Possible values:  1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
  • bucketDetails
    bucket details.
    

  • bucketDisplayName
    string
    bucket display name.
    

    Possible values:  1 ≤ length ≤ 10000, Value must match regular expression /.*/
    Examples:  
  • description
    string
    modified description.
    

    Possible values:  1 ≤ length ≤ 50, Value must match regular expression /.*/
    Examples:  
  • tags
    string[]
    Tags.
    

    Possible values:  0 ≤ number of items ≤ 10000, 1 ≤ length ≤ 1024, Value must match regular expression /.*/
    Examples:  
  • authInstanceId
    string
    Instance ID.
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9:\/-]+$/
  • curl -X PATCH -H "accept: application/json" -H "AuthInstanceId: {CRN}" -H "Content-Type: application/json" -d '{ "access_key": "<access_key>", "bucket_display_name": "sample-bucket-displayname", "description": "COS bucket for customer data", "secret_key": "<secret_key>", "tags": [ "testbucket", "userbucket" ] }' "https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/bucket_registrations/{bucket_id}"
  • bucketRegistrationPatchModel := &watsonxdatav2.BucketRegistrationPatch{
}
bucketRegistrationPatchModelAsPatch, asPatchErr := bucketRegistrationPatchModel.AsPatch()
Expect(asPatchErr).To(BeNil())

updateBucketRegistrationOptions := watsonxDataService.NewUpdateBucketRegistrationOptions(
  "testString",
  bucketRegistrationPatchModelAsPatch,
)

bucketRegistration, response, err := watsonxDataService.UpdateBucketRegistration(updateBucketRegistrationOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(bucketRegistration, "", "  ")
fmt.Println(string(b))
  • const params = {
  bucketId: 'testString',
};

let res;
try {
  res = await watsonxDataService.updateBucketRegistration(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
  • BucketRegistrationPatch bucketRegistrationPatchModel = new BucketRegistrationPatch.Builder()
  .build();
Map<String, Object> bucketRegistrationPatchModelAsPatch = bucketRegistrationPatchModel.asPatch();
UpdateBucketRegistrationOptions updateBucketRegistrationOptions = new UpdateBucketRegistrationOptions.Builder()
  .bucketId("testString")
  .body(bucketRegistrationPatchModelAsPatch)
  .build();

Response<BucketRegistration> response = watsonxDataService.updateBucketRegistration(updateBucketRegistrationOptions).execute();
BucketRegistration bucketRegistration = response.getResult();

System.out.println(bucketRegistration);
  • bucket_registration_patch_model = {
}

response = watsonx_data_service.update_bucket_registration(
  bucket_id='testString',
  body=bucket_registration_patch_model,
)
bucket_registration = response.get_result()

print(json.dumps(bucket_registration, indent=2))
Response
Response Body
BucketRegistration
Bucket


BucketRegistration
Bucket.


Examples:  
{
  "actions": [
    "create",
    "update"
  ],
  "associated_catalog": {
    "catalog_name": "hive_data",
    "catalog_type": "hive"
  },
  "bucket_display_name": "samplebucketdisplayname",
  "bucket_id": "samplebucketid",
  "bucket_name": "samplebucket",
  "bucket_type": "minio",
  "created_by": "username@domain.com",
  "created_on": "1699457595",
  "description": "default bucket",
  "endpoint": "https://s3.<region>.cloud-object-storage.appdomain.cloud/",
  "managed_by": "ibm",
  "region": "us-south",
  "state": "active",
  "tags": [
    "tag1",
    "tag2"
  ]
}
BucketRegistration
Bucket.


Examples:  
{
  "actions": [
    "create",
    "update"
  ],
  "associated_catalog": {
    "catalog_name": "hive_data",
    "catalog_type": "hive"
  },
  "bucket_display_name": "samplebucketdisplayname",
  "bucket_id": "samplebucketid",
  "bucket_name": "samplebucket",
  "bucket_type": "minio",
  "created_by": "username@domain.com",
  "created_on": "1699457595",
  "description": "default bucket",
  "endpoint": "https://s3.<region>.cloud-object-storage.appdomain.cloud/",
  "managed_by": "ibm",
  "region": "us-south",
  "state": "active",
  "tags": [
    "tag1",
    "tag2"
  ]
}
BucketRegistration
Bucket.


Examples:  
{
  "actions": [
    "create",
    "update"
  ],
  "associated_catalog": {
    "catalog_name": "hive_data",
    "catalog_type": "hive"
  },
  "bucket_display_name": "samplebucketdisplayname",
  "bucket_id": "samplebucketid",
  "bucket_name": "samplebucket",
  "bucket_type": "minio",
  "created_by": "username@domain.com",
  "created_on": "1699457595",
  "description": "default bucket",
  "endpoint": "https://s3.<region>.cloud-object-storage.appdomain.cloud/",
  "managed_by": "ibm",
  "region": "us-south",
  "state": "active",
  "tags": [
    "tag1",
    "tag2"
  ]
}
BucketRegistration
Bucket.


Examples:  
{
  "actions": [
    "create",
    "update"
  ],
  "associated_catalog": {
    "catalog_name": "hive_data",
    "catalog_type": "hive"
  },
  "bucket_display_name": "samplebucketdisplayname",
  "bucket_id": "samplebucketid",
  "bucket_name": "samplebucket",
  "bucket_type": "minio",
  "created_by": "username@domain.com",
  "created_on": "1699457595",
  "description": "default bucket",
  "endpoint": "https://s3.<region>.cloud-object-storage.appdomain.cloud/",
  "managed_by": "ibm",
  "region": "us-south",
  "state": "active",
  "tags": [
    "tag1",
    "tag2"
  ]
}
Status Code
  • 200
    Success
    

  • 400
    Error
    

  • 401
    Unauthorized
    

  • 404
    Not found
    

  • 500
    Internal server error
    

Example responses
  • {
  "actions": [
    "create",
    "update"
  ],
  "associated_catalog": {
    "catalog_name": "hive_data",
    "catalog_type": "hive"
  },
  "bucket_display_name": "samplebucketdisplayname",
  "bucket_id": "samplebucketid",
  "bucket_name": "samplebucket",
  "bucket_type": "minio",
  "created_by": "username@domain.com",
  "created_on": "1699457595",
  "description": "default bucket",
  "endpoint": "https://s3.<region>.cloud-object-storage.appdomain.cloud/",
  "managed_by": "ibm",
  "region": "us-south",
  "state": "active",
  "tags": [
    "tag1",
    "tag2"
  ]
}
  • {
  "actions": [
    "create",
    "update"
  ],
  "associated_catalog": {
    "catalog_name": "hive_data",
    "catalog_type": "hive"
  },
  "bucket_display_name": "samplebucketdisplayname",
  "bucket_id": "samplebucketid",
  "bucket_name": "samplebucket",
  "bucket_type": "minio",
  "created_by": "username@domain.com",
  "created_on": "1699457595",
  "description": "default bucket",
  "endpoint": "https://s3.<region>.cloud-object-storage.appdomain.cloud/",
  "managed_by": "ibm",
  "region": "us-south",
  "state": "active",
  "tags": [
    "tag1",
    "tag2"
  ]
}
Activate Bucket
Activate a registered bucket


Activate a registered bucket.


Activate a registered bucket.


Activate a registered bucket.


Activate a registered bucket.


POST /bucket_registrations/{bucket_id}/activate
(watsonxData *WatsonxDataV2) CreateActivateBucket(createActivateBucketOptions *CreateActivateBucketOptions) (result *CreateActivateBucketCreatedBody, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) CreateActivateBucketWithContext(ctx context.Context, createActivateBucketOptions *CreateActivateBucketOptions) (result *CreateActivateBucketCreatedBody, response *core.DetailedResponse, err error)
ServiceCall<CreateActivateBucketCreatedBody> createActivateBucket(CreateActivateBucketOptions createActivateBucketOptions)
create_activate_bucket(
        self,
        bucket_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
createActivateBucket(params)
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.
  • lakehouse.dashboard.view
Request
Instantiate the CreateActivateBucketOptions struct and set the fields to provide parameter values for the CreateActivateBucket method.
Use the CreateActivateBucketOptions.Builder to create a CreateActivateBucketOptions object that contains the parameter values for the createActivateBucket method.
Custom Headers
  • AuthInstanceId
    string
    CRN
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$
Path Parameters
  • bucket_id
    Required*
    string
    bucket id
    

    Possible values:  1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+$
parameter
WithContext method only
CreateActivateBucketOptions
The CreateActivateBucket options.


CreateActivateBucketOptions
The createActivateBucket options.


parameters
  • bucket_id
    Required*
    str
    bucket id.
    

    Possible values:  1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
  • auth_instance_id
    str
    CRN.
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/
parameters
  • bucketId
    Required*
    string
    bucket id.
    

    Possible values:  1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
  • authInstanceId
    string
    CRN.
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/
  • curl -X POST -H "accept: application/json" -H "AuthInstanceId: {CRN}" -H "Content-Type: application/json" -d "" "https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/bucket_registrations/{bucket_id}/activate"
  • createActivateBucketOptions := watsonxDataService.NewCreateActivateBucketOptions(
  "testString",
)

createActivateBucketCreatedBody, response, err := watsonxDataService.CreateActivateBucket(createActivateBucketOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(createActivateBucketCreatedBody, "", "  ")
fmt.Println(string(b))
  • const params = {
  bucketId: 'testString',
};

let res;
try {
  res = await watsonxDataService.createActivateBucket(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
  • CreateActivateBucketOptions createActivateBucketOptions = new CreateActivateBucketOptions.Builder()
  .bucketId("testString")
  .build();

Response<CreateActivateBucketCreatedBody> response = watsonxDataService.createActivateBucket(createActivateBucketOptions).execute();
CreateActivateBucketCreatedBody createActivateBucketCreatedBody = response.getResult();

System.out.println(createActivateBucketCreatedBody);
  • response = watsonx_data_service.create_activate_bucket(
  bucket_id='testString',
)
create_activate_bucket_created_body = response.get_result()

print(json.dumps(create_activate_bucket_created_body, indent=2))
Response
Response Body
CreateActivateBucketCreatedBody
Activate bucket


CreateActivateBucketCreatedBody
Activate bucket.


Examples:  
{
  "response": {
    "message": "Activate bucket",
    "message_code": "success"
  }
}
CreateActivateBucketCreatedBody
Activate bucket.


Examples:  
{
  "response": {
    "message": "Activate bucket",
    "message_code": "success"
  }
}
CreateActivateBucketCreatedBody
Activate bucket.


Examples:  
{
  "response": {
    "message": "Activate bucket",
    "message_code": "success"
  }
}
CreateActivateBucketCreatedBody
Activate bucket.


Examples:  
{
  "response": {
    "message": "Activate bucket",
    "message_code": "success"
  }
}
Status Code
  • 201
    Success
    

  • 400
    Error
    

  • 401
    Unauthorized
    

  • 404
    Not found
    

  • 500
    Internal server error
    

Example responses
  • {
  "response": {
    "message": "Activate bucket",
    "message_code": "success"
  }
}
  • {
  "response": {
    "message": "Activate bucket",
    "message_code": "success"
  }
}
Deactivate Bucket
Deactivate a bucket


Deactivate a bucket.


Deactivate a bucket.


Deactivate a bucket.


Deactivate a bucket.


DELETE /bucket_registrations/{bucket_id}/deactivate
(watsonxData *WatsonxDataV2) DeleteDeactivateBucket(deleteDeactivateBucketOptions *DeleteDeactivateBucketOptions) (response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) DeleteDeactivateBucketWithContext(ctx context.Context, deleteDeactivateBucketOptions *DeleteDeactivateBucketOptions) (response *core.DetailedResponse, err error)
ServiceCall<Void> deleteDeactivateBucket(DeleteDeactivateBucketOptions deleteDeactivateBucketOptions)
delete_deactivate_bucket(
        self,
        bucket_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
deleteDeactivateBucket(params)
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.
  • lakehouse.dashboard.view
Request
Instantiate the DeleteDeactivateBucketOptions struct and set the fields to provide parameter values for the DeleteDeactivateBucket method.
Use the DeleteDeactivateBucketOptions.Builder to create a DeleteDeactivateBucketOptions object that contains the parameter values for the deleteDeactivateBucket method.
Custom Headers
  • AuthInstanceId
    string
    CRN
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$
Path Parameters
  • bucket_id
    Required*
    string
    bucket id
    

    Possible values:  1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+$
parameter
WithContext method only
DeleteDeactivateBucketOptions
The DeleteDeactivateBucket options.


DeleteDeactivateBucketOptions
The deleteDeactivateBucket options.


parameters
  • bucket_id
    Required*
    str
    bucket id.
    

    Possible values:  1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
  • auth_instance_id
    str
    CRN.
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/
parameters
  • bucketId
    Required*
    string
    bucket id.
    

    Possible values:  1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
  • authInstanceId
    string
    CRN.
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/
  • curl -X DELETE -H "accept: */*" -H "AuthInstanceId: {CRN}" "https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/bucket_registrations/{bucket_id}/deactivate"
  • deleteDeactivateBucketOptions := watsonxDataService.NewDeleteDeactivateBucketOptions(
  "testString",
)

response, err := watsonxDataService.DeleteDeactivateBucket(deleteDeactivateBucketOptions)
if err != nil {
  panic(err)
}
if response.StatusCode != 204 {
  fmt.Printf("\nUnexpected response status code received from DeleteDeactivateBucket(): %d\n", response.StatusCode)
}
  • const params = {
  bucketId: 'testString',
};

try {
  await watsonxDataService.deleteDeactivateBucket(params);
} catch (err) {
  console.warn(err);
}
  • DeleteDeactivateBucketOptions deleteDeactivateBucketOptions = new DeleteDeactivateBucketOptions.Builder()
  .bucketId("testString")
  .build();

Response<Void> response = watsonxDataService.deleteDeactivateBucket(deleteDeactivateBucketOptions).execute();
  • response = watsonx_data_service.delete_deactivate_bucket(
  bucket_id='testString',
)
Response
Status Code
  • 204
    No Content
    

  • 400
    Error
    

  • 401
    Unauthorized
    

  • 404
    Not found
    

  • 500
    Internal server error
    

No Sample Response
This method does not specify any sample responses.
List bucket objects
Fetch all objects from a given bucket


Fetch all objects from a given bucket.


Fetch all objects from a given bucket.


Fetch all objects from a given bucket.


Fetch all objects from a given bucket.


GET /bucket_registrations/{bucket_id}/objects
(watsonxData *WatsonxDataV2) ListBucketObjects(listBucketObjectsOptions *ListBucketObjectsOptions) (result *BucketRegistrationObjectCollection, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) ListBucketObjectsWithContext(ctx context.Context, listBucketObjectsOptions *ListBucketObjectsOptions) (result *BucketRegistrationObjectCollection, response *core.DetailedResponse, err error)
ServiceCall<BucketRegistrationObjectCollection> listBucketObjects(ListBucketObjectsOptions listBucketObjectsOptions)
list_bucket_objects(
        self,
        bucket_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        path: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
listBucketObjects(params)
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.
  • lakehouse.bucket_registration_object.list
Request
Instantiate the ListBucketObjectsOptions struct and set the fields to provide parameter values for the ListBucketObjects method.
Use the ListBucketObjectsOptions.Builder to create a ListBucketObjectsOptions object that contains the parameter values for the listBucketObjects method.
Custom Headers
  • AuthInstanceId
    string
    CRN
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9:/-]+$
Path Parameters
  • bucket_id
    Required*
    string
    bucket id
    

    Possible values:  1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+$
Query Parameters
  • path
    string
    path
    

    Possible values:  1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+$
parameter
WithContext method only
ListBucketObjectsOptions
The ListBucketObjects options.


ListBucketObjectsOptions
The listBucketObjects options.


parameters
  • bucket_id
    Required*
    str
    bucket id.
    

    Possible values:  1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
  • auth_instance_id
    str
    Instance ID.
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9:\/-]+$/
  • path
    str
    path.
    

    Possible values:  1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
parameters
  • bucketId
    Required*
    string
    bucket id.
    

    Possible values:  1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
  • authInstanceId
    string
    Instance ID.
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9:\/-]+$/
  • path
    string
    path.
    

    Possible values:  1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
  • curl -X GET -H "accept: application/json" -H "AuthInstanceId: {CRN}" "https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/bucket_registrations/{bucket_id}/objects"
  • listBucketObjectsOptions := watsonxDataService.NewListBucketObjectsOptions(
  "testString",
)

bucketRegistrationObjectCollection, response, err := watsonxDataService.ListBucketObjects(listBucketObjectsOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(bucketRegistrationObjectCollection, "", "  ")
fmt.Println(string(b))
  • const params = {
  bucketId: 'testString',
};

let res;
try {
  res = await watsonxDataService.listBucketObjects(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
  • ListBucketObjectsOptions listBucketObjectsOptions = new ListBucketObjectsOptions.Builder()
  .bucketId("testString")
  .build();

Response<BucketRegistrationObjectCollection> response = watsonxDataService.listBucketObjects(listBucketObjectsOptions).execute();
BucketRegistrationObjectCollection bucketRegistrationObjectCollection = response.getResult();

System.out.println(bucketRegistrationObjectCollection);
  • response = watsonx_data_service.list_bucket_objects(
  bucket_id='testString',
)
bucket_registration_object_collection = response.get_result()

print(json.dumps(bucket_registration_object_collection, indent=2))
Response
Response Body
BucketRegistrationObjectCollection
List bucket objects


BucketRegistrationObjectCollection
List bucket objects.


Examples:  
{
  "objects": [
    "/path/file1.json",
    "/path/file2.txt",
    "/path/file3.csv",
    "/path/file4.parquet"
  ]
}
BucketRegistrationObjectCollection
List bucket objects.


Examples:  
{
  "objects": [
    "/path/file1.json",
    "/path/file2.txt",
    "/path/file3.csv",
    "/path/file4.parquet"
  ]
}
BucketRegistrationObjectCollection
List bucket objects.


Examples:  
{
  "objects": [
    "/path/file1.json",
    "/path/file2.txt",
    "/path/file3.csv",
    "/path/file4.parquet"
  ]
}
BucketRegistrationObjectCollection
List bucket objects.


Examples:  
{
  "objects": [
    "/path/file1.json",
    "/path/file2.txt",
    "/path/file3.csv",
    "/path/file4.parquet"
  ]
}
Status Code
  • 200
    Success
    

  • 400
    Error
    

  • 401
    Unauthorized
    

  • 404
    Not found
    

  • 500
    Internal server error
    

  • default
    Success
    

Example responses
  • {
  "objects": [
    "/path/file1.json",
    "/path/file2.txt",
    "/path/file3.csv",
    "/path/file4.parquet"
  ]
}
  • {
  "objects": [
    "/path/file1.json",
    "/path/file2.txt",
    "/path/file3.csv",
    "/path/file4.parquet"
  ]
}
Get bucket object properties
Get bucket object properties


Get bucket object properties.


Get bucket object properties.


Get bucket object properties.


Get bucket object properties.


POST /bucket_registrations/{bucket_id}/object_properties
(watsonxData *WatsonxDataV2) GetBucketObjectProperties(getBucketObjectPropertiesOptions *GetBucketObjectPropertiesOptions) (result *BucketObjectProperties, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) GetBucketObjectPropertiesWithContext(ctx context.Context, getBucketObjectPropertiesOptions *GetBucketObjectPropertiesOptions) (result *BucketObjectProperties, response *core.DetailedResponse, err error)
ServiceCall<BucketObjectProperties> getBucketObjectProperties(GetBucketObjectPropertiesOptions getBucketObjectPropertiesOptions)
get_bucket_object_properties(
        self,
        bucket_id: str,
        *,
        paths: Optional[List['Path']] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
getBucketObjectProperties(params)
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.
  • lakehouse.bucket.object.properties
Request
Instantiate the GetBucketObjectPropertiesOptions struct and set the fields to provide parameter values for the GetBucketObjectProperties method.
Use the GetBucketObjectPropertiesOptions.Builder to create a GetBucketObjectPropertiesOptions object that contains the parameter values for the getBucketObjectProperties method.
Custom Headers
  • AuthInstanceId
    string
    CRN
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$
Path Parameters
  • bucket_id
    Required*
    string
    bucket id
    

    Possible values:  1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+$
Request Body
Required*
BucketObjectSize
Request body


parameter
WithContext method only
GetBucketObjectPropertiesOptions
The GetBucketObjectProperties options.


GetBucketObjectPropertiesOptions
The getBucketObjectProperties options.


parameters
  • bucket_id
    Required*
    str
    bucket id.
    

    Possible values:  1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
  • paths
    bucket object size.
    

    Possible values:  0 ≤ number of items ≤ 10000
  • auth_instance_id
    str
    watsonx.data instance ID.
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/
parameters
  • bucketId
    Required*
    string
    bucket id.
    

    Possible values:  1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
  • paths
    bucket object size.
    

    Possible values:  0 ≤ number of items ≤ 10000
  • authInstanceId
    string
    watsonx.data instance ID.
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/
  • curl -X POST -H "accept: application/json" -H "AuthInstanceId: {CRN}" -H "Content-Type: application/json" -d '{ "associated_catalog": { "catalog_name": "<access_key>", "catalog_type": "sample-bucket" } }' "https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/bucket_registrations"
  • getBucketObjectPropertiesOptions := watsonxDataService.NewGetBucketObjectPropertiesOptions(
  "testString",
)

bucketObjectProperties, response, err := watsonxDataService.GetBucketObjectProperties(getBucketObjectPropertiesOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(bucketObjectProperties, "", "  ")
fmt.Println(string(b))
  • const params = {
  bucketId: 'testString',
};

let res;
try {
  res = await watsonxDataService.getBucketObjectProperties(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
  • GetBucketObjectPropertiesOptions getBucketObjectPropertiesOptions = new GetBucketObjectPropertiesOptions.Builder()
  .bucketId("testString")
  .build();

Response<BucketObjectProperties> response = watsonxDataService.getBucketObjectProperties(getBucketObjectPropertiesOptions).execute();
BucketObjectProperties bucketObjectProperties = response.getResult();

System.out.println(bucketObjectProperties);
  • response = watsonx_data_service.get_bucket_object_properties(
  bucket_id='testString',
)
bucket_object_properties = response.get_result()

print(json.dumps(bucket_object_properties, indent=2))
Response
Response Body
BucketObjectProperties
muliple bucket object properties


BucketObjectProperties
muliple bucket object properties.


Examples:  
{
  "object_properties": [
    {
      "content_type": "string",
      "file_type": "string",
      "last_modified": "utc-2014-07",
      "metadata": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "path": "abc/abc/data",
      "size": "1024"
    }
  ]
}
BucketObjectProperties
muliple bucket object properties.


Examples:  
{
  "object_properties": [
    {
      "content_type": "string",
      "file_type": "string",
      "last_modified": "utc-2014-07",
      "metadata": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "path": "abc/abc/data",
      "size": "1024"
    }
  ]
}
BucketObjectProperties
muliple bucket object properties.


Examples:  
{
  "object_properties": [
    {
      "content_type": "string",
      "file_type": "string",
      "last_modified": "utc-2014-07",
      "metadata": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "path": "abc/abc/data",
      "size": "1024"
    }
  ]
}
BucketObjectProperties
muliple bucket object properties.


Examples:  
{
  "object_properties": [
    {
      "content_type": "string",
      "file_type": "string",
      "last_modified": "utc-2014-07",
      "metadata": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "path": "abc/abc/data",
      "size": "1024"
    }
  ]
}
Status Code
  • 201
    Success
    

  • 400
    Error
    

  • 401
    Unauthorized
    

  • 404
    Not found
    

  • 500
    Internal server error
    

Example responses
  • {
  "object_properties": [
    {
      "content_type": "string",
      "file_type": "string",
      "last_modified": "utc-2014-07",
      "metadata": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "path": "abc/abc/data",
      "size": "1024"
    }
  ]
}
  • {
  "object_properties": [
    {
      "content_type": "string",
      "file_type": "string",
      "last_modified": "utc-2014-07",
      "metadata": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "path": "abc/abc/data",
      "size": "1024"
    }
  ]
}
Add/Create HDFS storage
Add or create a new HDFS database


Add or create a new HDFS database.


Add or create a new HDFS database.


Add or create a new HDFS database.


Add or create a new HDFS database.


POST /storage_hdfs_registrations
(watsonxData *WatsonxDataV2) CreateHdfsStorage(createHdfsStorageOptions *CreateHdfsStorageOptions) (result *HdfsStorageRegistration, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) CreateHdfsStorageWithContext(ctx context.Context, createHdfsStorageOptions *CreateHdfsStorageOptions) (result *HdfsStorageRegistration, response *core.DetailedResponse, err error)
ServiceCall<HdfsStorageRegistration> createHdfsStorage(CreateHdfsStorageOptions createHdfsStorageOptions)
create_hdfs_storage(
        self,
        bucket_display_name: str,
        bucket_type: str,
        hms_thrift_uri: str,
        hms_thrift_port: int,
        core_site: str,
        hdfs_site: str,
        kerberos: str,
        catalog_name: str,
        catalog_type: str,
        *,
        krb5_config: Optional[str] = None,
        hive_keytab: Optional[BinaryIO] = None,
        hive_keytab_content_type: Optional[str] = None,
        hdfs_keytab: Optional[BinaryIO] = None,
        hdfs_keytab_content_type: Optional[str] = None,
        hive_server_principal: Optional[str] = None,
        hive_client_principal: Optional[str] = None,
        hdfs_principal: Optional[str] = None,
        description: Optional[str] = None,
        created_on: Optional[str] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
createHdfsStorage(params)
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.
  • lakehouse.storage_hdfs_registration.create
Request
Instantiate the CreateHdfsStorageOptions struct and set the fields to provide parameter values for the CreateHdfsStorage method.
Use the CreateHdfsStorageOptions.Builder to create a CreateHdfsStorageOptions object that contains the parameter values for the createHdfsStorage method.
Custom Headers
  • AuthInstanceId
    string
    CRN
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9:/-]+$
Form Parameters
  • bucket_display_name
    Required*
    string
    Bucket display name
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-]+$
  • bucket_type
    Required*
    string
    Bucket type
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-]+$
  • hms_thrift_uri
    Required*
    string
    HMS Thrift URI
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-]+$
  • hms_thrift_port
    Required*
    integer
    HMS Thrift Port
    

    Possible values:  1 ≤ value ≤ 65535
  • core_site
    Required*
    string
    contents of core-site.xml file
    

    Possible values:  1 ≤ length ≤ 20000, Value must match regular expression ^.*$
  • hdfs_site
    Required*
    string
    contents of hdfs-site.xml file
    

    Possible values:  1 ≤ length ≤ 20000, Value must match regular expression ^.*$
  • kerberos
    Required*
    string
    Kerberos Flag
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression ^true$|^false$
  • catalog_name
    Required*
    string
    Catalog name
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-_]+$
  • catalog_type
    Required*
    string
    Catalog type
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-]+$
  • krb5_config
    string
    Kerberos config file
    

    Possible values:  1 ≤ length ≤ 20000, Value must match regular expression ^.*$
  • hive_keytab
    binary
    Hive keytab file
    

    Possible values:  1 ≤ length ≤ 104857600
  • hdfs_keytab
    binary
    HDFS keytab file
    

    Possible values:  1 ≤ length ≤ 104857600
  • hive_server_principal
    string
    Hive server principal
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-]+$
  • hive_client_principal
    string
    Hive client principal
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-]+$
  • hdfs_principal
    string
    HDFS principal
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-]+$
  • description
    string
    Database description
    

    Possible values:  1 ≤ length ≤ 10000, Value must match regular expression ^[a-zA-Z0-9\-]+$
  • created_on
    string
    Created on
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-]+$
parameter
WithContext method only
CreateHdfsStorageOptions
The CreateHdfsStorage options.


CreateHdfsStorageOptions
The createHdfsStorage options.


parameters
  • bucket_display_name
    Required*
    str
    Bucket display name.
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
  • bucket_type
    Required*
    str
    Bucket type.
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
  • hms_thrift_uri
    Required*
    str
    HMS Thrift URI.
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
  • hms_thrift_port
    Required*
    int
    HMS Thrift Port.
    

    Possible values:  1 ≤ value ≤ 65535
  • core_site
    Required*
    str
    contents of core-site.xml file.
    

    Possible values:  1 ≤ length ≤ 20000, Value must match regular expression /.*/
  • hdfs_site
    Required*
    str
    contents of hdfs-site.xml file.
    

    Possible values:  1 ≤ length ≤ 20000, Value must match regular expression /.*/
  • kerberos
    Required*
    str
    Kerberos Flag.
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression /^true$|^false$/
  • catalog_name
    Required*
    str
    Catalog name.
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-_]+/
  • catalog_type
    Required*
    str
    Catalog type.
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
  • krb5_config
    str
    Kerberos config file.
    

    Possible values:  1 ≤ length ≤ 20000, Value must match regular expression /.*/
  • hive_keytab
    BinaryIO
    Hive keytab file.
    

    Possible values:  1 ≤ length ≤ 104857600
  • hive_keytab_content_type
    str
    The content type of hive_keytab.
    

  • hdfs_keytab
    BinaryIO
    HDFS keytab file.
    

    Possible values:  1 ≤ length ≤ 104857600
  • hdfs_keytab_content_type
    str
    The content type of hdfs_keytab.
    

  • hive_server_principal
    str
    Hive server principal.
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
  • hive_client_principal
    str
    Hive client principal.
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
  • hdfs_principal
    str
    HDFS principal.
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
  • description
    str
    Database description.
    

    Possible values:  1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
  • created_on
    str
    Created on.
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
  • auth_instance_id
    str
    Instance ID.
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9:\/-]+$/
parameters
  • bucketDisplayName
    Required*
    string
    Bucket display name.
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
  • bucketType
    Required*
    string
    Bucket type.
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
  • hmsThriftUri
    Required*
    string
    HMS Thrift URI.
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
  • hmsThriftPort
    Required*
    number
    HMS Thrift Port.
    

    Possible values:  1 ≤ value ≤ 65535
  • coreSite
    Required*
    string
    contents of core-site.xml file.
    

    Possible values:  1 ≤ length ≤ 20000, Value must match regular expression /.*/
  • hdfsSite
    Required*
    string
    contents of hdfs-site.xml file.
    

    Possible values:  1 ≤ length ≤ 20000, Value must match regular expression /.*/
  • kerberos
    Required*
    string
    Kerberos Flag.
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression /^true$|^false$/
  • catalogName
    Required*
    string
    Catalog name.
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-_]+/
  • catalogType
    Required*
    string
    Catalog type.
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
  • krb5Config
    string
    Kerberos config file.
    

    Possible values:  1 ≤ length ≤ 20000, Value must match regular expression /.*/
  • hiveKeytab
    NodeJS.ReadableStream
    Hive keytab file.
    

    Possible values:  1 ≤ length ≤ 104857600
  • hiveKeytabContentType
    string
    The content type of hiveKeytab.
    

  • hdfsKeytab
    NodeJS.ReadableStream
    HDFS keytab file.
    

    Possible values:  1 ≤ length ≤ 104857600
  • hdfsKeytabContentType
    string
    The content type of hdfsKeytab.
    

  • hiveServerPrincipal
    string
    Hive server principal.
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
  • hiveClientPrincipal
    string
    Hive client principal.
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
  • hdfsPrincipal
    string
    HDFS principal.
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
  • description
    string
    Database description.
    

    Possible values:  1 ≤ length ≤ 10000, Value must match regular expression /^[a-zA-Z0-9\\-]+/
  • createdOn
    string
    Created on.
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
  • authInstanceId
    string
    Instance ID.
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9:\/-]+$/
  • curl -X POST -H "accept: application/json" -H "AuthInstanceId: 00000000000" -H "Content-Type: multipart/form-data" -F "bucket_display_name=Sample_Hdfs" -F "bucket_type=hdfs" -F "hms_thrift_uri=thrif://hms.example.com" -F "hms_thrift_port=9083" -F "core_site=<contents of core-site.xml file>" -F "hdfs_site=<contents of hdfs-site.xml file>" -F "kerberos=true" -F "krb5_config=<contents of krb5.conf file>" -F "hive_keytab=hive.keytab file" -F "hdfs_keytab=hdfs.keytab file" -F "hive_server_principal=hive/_HOST@EXAMPLE.COM" -F "hive_client_principal=hive/_HOST@EXAMPLE.COM" -F "hdfs_principal=hdfs/_HOST@EXAMPLE.COM" -F "catalog_name=sample_catalog" -F "catalog_type=hive-hadoop2" -F "description=Sample  description" -F "created_on=1686120645" "https://us.lakehouse.cloud.ibm.com/lakehouse/api/v2/storage_hdfs_registrations"
  • createHdfsStorageOptions := watsonxDataService.NewCreateHdfsStorageOptions(
  "testString",
  "testString",
  "testString",
  int64(1),
  "testString",
  "testString",
  "testString",
  "testString",
  "testString",
)

hdfsStorageRegistration, response, err := watsonxDataService.CreateHdfsStorage(createHdfsStorageOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(hdfsStorageRegistration, "", "  ")
fmt.Println(string(b))
  • const params = {
  bucketDisplayName: 'testString',
  bucketType: 'testString',
  hmsThriftUri: 'testString',
  hmsThriftPort: 1,
  coreSite: 'testString',
  hdfsSite: 'testString',
  kerberos: 'testString',
  catalogName: 'testString',
  catalogType: 'testString',
};

let res;
try {
  res = await watsonxDataService.createHdfsStorage(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
  • CreateHdfsStorageOptions createHdfsStorageOptions = new CreateHdfsStorageOptions.Builder()
  .bucketDisplayName("testString")
  .bucketType("testString")
  .hmsThriftUri("testString")
  .hmsThriftPort(Long.valueOf("1"))
  .coreSite("testString")
  .hdfsSite("testString")
  .kerberos("testString")
  .catalogName("testString")
  .catalogType("testString")
  .build();

Response<HdfsStorageRegistration> response = watsonxDataService.createHdfsStorage(createHdfsStorageOptions).execute();
HdfsStorageRegistration hdfsStorageRegistration = response.getResult();

System.out.println(hdfsStorageRegistration);
  • response = watsonx_data_service.create_hdfs_storage(
  bucket_display_name='testString',
  bucket_type='testString',
  hms_thrift_uri='testString',
  hms_thrift_port=1,
  core_site='testString',
  hdfs_site='testString',
  kerberos='testString',
  catalog_name='testString',
  catalog_type='testString',
)
hdfs_storage_registration = response.get_result()

print(json.dumps(hdfs_storage_registration, indent=2))
Response
Response Body
HdfsStorageRegistration
HDFS storage registration


HdfsStorageRegistration
HDFS storage registration.


Examples:  
{
  "actions": [
    "create",
    "update"
  ],
  "associated_catalog": {
    "catalog_name": "hive_data",
    "catalog_type": "hive"
  },
  "bucket_display_name": "samplehdfsdisplayname",
  "bucket_id": "hdfs123",
  "bucket_type": "hdfs",
  "created_by": "username@domain.com",
  "created_on": "1699457595",
  "description": "default hdfs",
  "managed_by": "customer",
  "state": "active",
  "tags": [
    "tag1",
    "tag2"
  ]
}
HdfsStorageRegistration
HDFS storage registration.


Examples:  
{
  "actions": [
    "create",
    "update"
  ],
  "associated_catalog": {
    "catalog_name": "hive_data",
    "catalog_type": "hive"
  },
  "bucket_display_name": "samplehdfsdisplayname",
  "bucket_id": "hdfs123",
  "bucket_type": "hdfs",
  "created_by": "username@domain.com",
  "created_on": "1699457595",
  "description": "default hdfs",
  "managed_by": "customer",
  "state": "active",
  "tags": [
    "tag1",
    "tag2"
  ]
}
HdfsStorageRegistration
HDFS storage registration.


Examples:  
{
  "actions": [
    "create",
    "update"
  ],
  "associated_catalog": {
    "catalog_name": "hive_data",
    "catalog_type": "hive"
  },
  "bucket_display_name": "samplehdfsdisplayname",
  "bucket_id": "hdfs123",
  "bucket_type": "hdfs",
  "created_by": "username@domain.com",
  "created_on": "1699457595",
  "description": "default hdfs",
  "managed_by": "customer",
  "state": "active",
  "tags": [
    "tag1",
    "tag2"
  ]
}
HdfsStorageRegistration
HDFS storage registration.


Examples:  
{
  "actions": [
    "create",
    "update"
  ],
  "associated_catalog": {
    "catalog_name": "hive_data",
    "catalog_type": "hive"
  },
  "bucket_display_name": "samplehdfsdisplayname",
  "bucket_id": "hdfs123",
  "bucket_type": "hdfs",
  "created_by": "username@domain.com",
  "created_on": "1699457595",
  "description": "default hdfs",
  "managed_by": "customer",
  "state": "active",
  "tags": [
    "tag1",
    "tag2"
  ]
}
Status Code
  • 201
    Success
    

  • 400
    Error
    

  • 401
    Unauthorized
    

  • 404
    Not found
    

  • 500
    Internal server error
    

Example responses
  • {
  "actions": [
    "create",
    "update"
  ],
  "associated_catalog": {
    "catalog_name": "hive_data",
    "catalog_type": "hive"
  },
  "bucket_display_name": "samplehdfsdisplayname",
  "bucket_id": "hdfs123",
  "bucket_type": "hdfs",
  "created_by": "username@domain.com",
  "created_on": "1699457595",
  "description": "default hdfs",
  "managed_by": "customer",
  "state": "active",
  "tags": [
    "tag1",
    "tag2"
  ]
}
  • {
  "actions": [
    "create",
    "update"
  ],
  "associated_catalog": {
    "catalog_name": "hive_data",
    "catalog_type": "hive"
  },
  "bucket_display_name": "samplehdfsdisplayname",
  "bucket_id": "hdfs123",
  "bucket_type": "hdfs",
  "created_by": "username@domain.com",
  "created_on": "1699457595",
  "description": "default hdfs",
  "managed_by": "customer",
  "state": "active",
  "tags": [
    "tag1",
    "tag2"
  ]
}
Get databases
Get list of databases


Get list of databases.


Get list of databases.


Get list of databases.


Get list of databases.


GET /database_registrations
(watsonxData *WatsonxDataV2) ListDatabaseRegistrations(listDatabaseRegistrationsOptions *ListDatabaseRegistrationsOptions) (result *DatabaseRegistrationCollection, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) ListDatabaseRegistrationsWithContext(ctx context.Context, listDatabaseRegistrationsOptions *ListDatabaseRegistrationsOptions) (result *DatabaseRegistrationCollection, response *core.DetailedResponse, err error)
ServiceCall<DatabaseRegistrationCollection> listDatabaseRegistrations(ListDatabaseRegistrationsOptions listDatabaseRegistrationsOptions)
list_database_registrations(
        self,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
listDatabaseRegistrations(params)
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.
  • lakehouse.database_registration.list
Request
Instantiate the ListDatabaseRegistrationsOptions struct and set the fields to provide parameter values for the ListDatabaseRegistrations method.
Use the ListDatabaseRegistrationsOptions.Builder to create a ListDatabaseRegistrationsOptions object that contains the parameter values for the listDatabaseRegistrations method.
Custom Headers
  • AuthInstanceId
    string
    CRN
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$
parameter
WithContext method only
ListDatabaseRegistrationsOptions
The ListDatabaseRegistrations options.


ListDatabaseRegistrationsOptions
The listDatabaseRegistrations options.


parameters
  • auth_instance_id
    str
    watsonx.data instance ID.
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/
parameters
  • authInstanceId
    string
    watsonx.data instance ID.
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-\\:\/]+$/
  • curl -X GET -H "accept: application/json" -H "AuthInstanceId: {CRN}" "https://{region}.lakehouse.cloud.ibm.com/lakehouse/api/v2/database_registrations"
  • listDatabaseRegistrationsOptions := watsonxDataService.NewListDatabaseRegistrationsOptions()

databaseRegistrationCollection, response, err := watsonxDataService.ListDatabaseRegistrations(listDatabaseRegistrationsOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(databaseRegistrationCollection, "", "  ")
fmt.Println(string(b))
  • let res;
try {
  res = await watsonxDataService.listDatabaseRegistrations({});
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
  • ListDatabaseRegistrationsOptions listDatabaseRegistrationsOptions = new ListDatabaseRegistrationsOptions.Builder()
  .build();

Response<DatabaseRegistrationCollection> response = watsonxDataService.listDatabaseRegistrations(listDatabaseRegistrationsOptions).execute();
DatabaseRegistrationCollection databaseRegistrationCollection = response.getResult();

System.out.println(databaseRegistrationCollection);
  • response = watsonx_data_service.list_database_registrations()
database_registration_collection = response.get_result()

print(json.dumps(database_registration_collection, indent=2))
Response
Response Body
DatabaseRegistrationCollection
list database registrations


DatabaseRegistrationCollection
list database registrations.


Examples:  
{
  "database_registrations": [
    {
      "actions": [
        "update",
        "delete"
      ],
      "associated_catalog": {
        "catalog_name": "hive_data",
        "catalog_tags": [
          "catalog_tag_1",
          "catalog_tag_2"
        ],
        "catalog_type": "hive"
      },
      "created_by": "user1@bim.com",
      "created_on": "1686792721",
      "database_details": {
        "database_name": "new_database",
        "hostname": "netezza://ps.fyre.com",
        "password": "samplepassword",
        "port": 4353,
        "ssl": true,
        "tables": "netezza_table_name",
        "username": "sampleuser"
      },
      "database_display_name": "new_database",
      "database_id": "new_database_id",
      "database_type": "netezza",
      "description": "Description of the external database",
      "tags": [
        "testdatabase",
        "userdatabase"
      ]
    }
  ]
}
DatabaseRegistrationCollection
list database registrations.


Examples:  
{
  "database_registrations": [
    {
      "actions": [
        "update",
        "delete"
      ],
      "associated_catalog": {
        "catalog_name": "hive_data",
        "catalog_tags": [
          "catalog_tag_1",
          "catalog_tag_2"
        ],
        "catalog_type": "hive"
      },
      "created_by": "user1@bim.com",
      "created_on": "1686792721",
      "database_details": {
        "database_name": "new_database",
        "hostname": "netezza://ps.fyre.com",
        "password": "samplepassword",
        "port": 4353,
        "ssl": true,
        "tables": "netezza_table_name",
        "username": "sampleuser"
      },
      "database_display_name": "new_database",
      "database_id": "new_database_id",
      "database_type": "netezza",
      "description": "Description of the external database",
      "tags": [
        "testdatabase",
        "userdatabase"
      ]
    }
  ]
}
DatabaseRegistrationCollection
list database registrations.


Examples:  
{
  "database_registrations": [
    {
      "actions": [
        "update",
        "delete"
      ],
      "associated_catalog": {
        "catalog_name": "hive_data",
        "catalog_tags": [
          "catalog_tag_1",
          "catalog_tag_2"
        ],
        "catalog_type": "hive"
      },
      "created_by": "user1@bim.com",
      "created_on": "1686792721",
      "database_details": {
        "database_name": "new_database",
        "hostname": "netezza://ps.fyre.com",
        "password": "samplepassword",
        "port": 4353,
        "ssl": true,
        "tables": "netezza_table_name",
        "username": "sampleuser"
      },
      "database_display_name": "new_database",
      "database_id": "new_database_id",
      "database_type": "netezza",
      "description": "Description of the external database",
      "tags": [
        "testdatabase",
        "userdatabase"
      ]
    }
  ]
}
DatabaseRegistrationCollection
list database registrations.


Examples:  
{
  "database_registrations": [
    {
      "actions": [
        "update",
        "delete"
      ],
      "associated_catalog": {
        "catalog_name": "hive_data",
        "catalog_tags": [
          "catalog_tag_1",
          "catalog_tag_2"
        ],
        "catalog_type": "hive"
      },
      "created_by": "user1@bim.com",
      "created_on": "1686792721",
      "database_details": {
        "database_name": "new_database",
        "hostname": "netezza://ps.fyre.com",
        "password": "samplepassword",
        "port": 4353,
        "ssl": true,
        "tables": "netezza_table_name",
        "username": "sampleuser"
      },
      "database_display_name": "new_database",
      "database_id": "new_database_id",
      "database_type": "netezza",
      "description": "Description of the external database",
      "tags": [
        "testdatabase",
        "userdatabase"
      ]
    }
  ]
}
Status Code
  • 200
    Success
    

  • 400
    Error
    

  • 401
    Unauthorized
    

  • 404
    Not found
    

  • 500
    Internal server error
    

Example responses
  • {
  "database_registrations": [
    {
      "actions": [
        "update",
        "delete"
      ],
      "associated_catalog": {
        "catalog_name": "hive_data",
        "catalog_tags": [
          "catalog_tag_1",
          "catalog_tag_2"
        ],
        "catalog_type": "hive"
      },
      "created_by": "user1@bim.com",
      "created_on": "1686792721",
      "database_details": {
        "database_name": "new_database",
        "hostname": "netezza://ps.fyre.com",
        "password": "samplepassword",
        "port": 4353,
        "ssl": true,
        "tables": "netezza_table_name",
        "username": "sampleuser"
      },
      "database_display_name": "new_database",
      "database_id": "new_database_id",
      "database_type": "netezza",
      "description": "Description of the external database",
      "tags": [
        "testdatabase",
        "userdatabase"
      ]
    }
  ]
}
  • {
  "database_registrations": [
    {
      "actions": [
        "update",
        "delete"
      ],
      "associated_catalog": {
        "catalog_name": "hive_data",
        "catalog_tags": [
          "catalog_tag_1",
          "catalog_tag_2"
        ],
        "catalog_type": "hive"
      },
      "created_by": "user1@bim.com",
      "created_on": "1686792721",
      "database_details": {
        "database_name": "new_database",
        "hostname": "netezza://ps.fyre.com",
        "password": "samplepassword",
        "port": 4353,
        "ssl": true,
        "tables": "netezza_table_name",
        "username": "sampleuser"
      },
      "database_display_name": "new_database",
      "database_id": "new_database_id",
      "database_type": "netezza",
      "description": "Description of the external database",
      "tags": [
        "testdatabase",
        "userdatabase"
      ]
    }
  ]
}
Add/Create database
Add or create a new database


Add or create a new database.


Add or create a new database.


Add or create a new database.


Add or create a new database.


POST /database_registrations
(watsonxData *WatsonxDataV2) CreateDatabaseRegistration(createDatabaseRegistrationOptions *CreateDatabaseRegistrationOptions) (result *DatabaseRegistration, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) CreateDatabaseRegistrationWithContext(ctx context.Context, createDatabaseRegistrationOptions *CreateDatabaseRegistrationOptions) (result *DatabaseRegistration, response *core.DetailedResponse, err error)
ServiceCall<DatabaseRegistration> createDatabaseRegistration(CreateDatabaseRegistrationOptions createDatabaseRegistrationOptions)
create_database_registration(
        self,
        database_display_name: str,
        database_type: str,
        *,
        associated_catalog: Optional['DatabaseCatalog'] = None,
        created_on: Optional[str] = None,
        database_details: Optional['DatabaseDetails'] = None,
        database_properties: Optional[List['DatabaseRegistrationPrototypeDatabasePropertiesItems']] = None,
        description: Optional[str] = None,
        tags: Optional[List[str]] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
createDatabaseRegistration(params)
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.
  • lakehouse.database_registration.create
Request
Instantiate the CreateDatabaseRegistrationOptions struct and set the fields to provide parameter values for the CreateDatabaseRegistration method.
Use the CreateDatabaseRegistrationOptions.Builder to create a CreateDatabaseRegistrationOptions object that contains the parameter values for the createDatabaseRegistration method.
Custom Headers
  • AuthInstanceId
    string
    CRN
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression ^[a-zA-Z0-9\-\:/]+$
Request Body
Required*
DatabaseRegistrationPrototype
Request body


parameter
WithContext method only
CreateDatabaseRegistrationOptions
The CreateDatabaseRegistration options.


CreateDatabaseRegistrationOptions
The createDatabaseRegistration options.


parameters
  • database_display_name
    Required*
    str
    Database display name.
    

    Possible values:  1 ≤ length ≤ 10000, Value must match regular expression /.*/
    Examples:  
  • database_type
    Required*
    str
    Connector type.
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
    Examples:  
  • associated_catalog
    database catalog.
    

    Examples:  
    {
  "catalog_name": "iceberg_catalog",
  "catalog_type": "iceberg"
}
  • created_on
    str
    Created on.
    

    Possible values:  1 ≤ length ≤ 128, Value must match regular expression /^[a-zA-Z0-9\\-]+/
    Examples:  
  • database_details
    database details.