Updated on 2025-09-09 GMT+08:00

OBS Connection Parameters (Internal Test)

Table 1 OBS connection

Parameter

Mandatory

Description

Data Connection Type

Yes

Object Storage Service (OBS) is selected by default and cannot be changed.

Name

Yes

Name of the data connection to create. Data connection names can contain a maximum of 100 characters. They can contain only letters, digits, underscores (_), and hyphens (-).

Description

No

A description which can help identify the data connection more easily. It can contain a maximum of 100 characters.

Tag

No

Attribute of the data connection to create. Tags make management easier.
NOTE:

The tag name can contain only letters, digits, and underscores (_) and cannot start with an underscore (_) or contain more than 100 characters.

Applicable Modules

Yes

Select the modules for which this connection is available.

NOTE:
  • When offline or real-time data migration jobs are enabled, you can select the DataArts Migration module. Then you can select this data connection when creating a data migration job in DataArts Factory.
  • You can use offline or real-time data migration jobs only after you apply for the whitelist membership. To use this feature, contact customer service or technical support.

Basic and Network Connectivity Configuration

OBS Endpoint

Yes

An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. You can obtain the OBS bucket endpoint by either of the following means:

To obtain the endpoint of an OBS bucket, go to the OBS console and click the bucket name to go to its details page.

Port

Yes

SSH port number of the host

KMS Key

Yes

KMS key used to encrypt and decrypt data source authentication information. Select a default or custom key.
NOTE:
  • When you use KMS for encryption through DataArts Studio or KPS for the first time, the default key dlf/default or kps/default is automatically generated. For more information about default keys, see What Is a Default Master Key?.
  • Only symmetric keys are supported. Asymmetric keys are not supported.

Agent

Yes

Data Warehouse Service (DWS) is not a fully managed service and thus cannot be directly connected to DataArts Studio. A CDM cluster can provide an agent for DataArts Studio to communicate with non-fully-managed services. Therefore, you need to select a CDM cluster when creating a DWS data connection. If no CDM cluster is available, create one first by referring to Creating a CDM Cluster.

As a network proxy, the CDM cluster must be able to communicate with the DWS cluster. To ensure network connectivity, the CDM cluster must be in the same region and AZ and use the same VPC and subnet as the DWS cluster. The security group rule must also allow the CDM cluster to communicate with the DWS cluster.

Data Source Authentication and Other Function Configuration

Use Agency

No

This parameter is displayed when DataArts Migration is selected and DataArts Catalog is not selected.

If an IAM account delegates OBS permissions to DataArts Studio, you can create a data connection without holding permanent OBS AK and SK. Cloud services can delegate jobs to DataArts Studio.

Public agency

Yes

This parameter is displayed when DataArts Migration is selected and DataArts Catalog is not selected.

Public agency that applies to all jobs in the workspace. For details about how to configure a public agency, see Configuring a Public Agency.

AK

Yes

This parameter is displayed when Use Agency is disabled.

AK and SK are used to log in to the OBS server.

You need to create an access key for the current account and obtain an AK/SK pair.

To obtain an access key, perform the following steps:
  1. Log in to the management console, move the cursor to the username in the upper right corner, and select My Credentials from the drop-down list.
  2. On the My Credentials page, choose Access Keys, and click Create Access Key. See Figure 1.
    Figure 1 Clicking Create Access Key
  3. Click OK and save the access key file as prompted. The access key file will be saved to your browser's configured download location. Open the credentials.csv file to view Access Key Id and Secret Access Key.
    NOTE:
    • Only two access keys can be added for each user.
    • To ensure access key security, the access key is automatically downloaded only when it is generated for the first time and cannot be obtained from the management console later. Keep them properly.

SK

Yes