Gunakan UpdateDataSource API untuk Modifikasi Config Data Source - Quick BI - Alibaba Cloud - Quick BI

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tidak ada otorisasi untuk operasi ini. Jika Anda mengalami masalah saat menjalankan operasi ini, hubungi dukungan teknis.

Sintaks permintaan

POST  HTTP/1.1

Parameter permintaan

Parameter	Type	Required	Description	Example
UpdateModel	string	Yes	String berformat JSON yang mendefinisikan konfigurasi sumber data yang akan diperbarui. Lihat contoh untuk format spesifiknya. String JSON tersebut mencakup parameter berikut: `dsId`: Wajib. ID sumber data. `userId`: Opsional. ID pengguna Quick BI dari pengguna yang memodifikasi sumber data. Jika Anda menentukan parameter ini, pembaruan dijalankan atas nama pengguna tersebut. `dsType`: Wajib. Jenis sumber data. Nilai ini tidak dapat diubah dan harus sesuai dengan jenis sumber data yang sudah ada. `showName`: Opsional. Nama tampilan sumber data. `address`: Opsional. Endpoint koneksi database, yang dapat berupa nama domain atau alamat IP. `port`: Opsional. Port koneksi untuk database. `schema`: Opsional. Skema database. Parameter ini hanya diperlukan untuk jenis database yang mendukung skema. Misalnya, skema default untuk SQL Server adalah `dbo`, sedangkan MySQL tidak menggunakan skema. `instance`: Opsional. Instance database. `username`: Opsional. Nama pengguna untuk akun database atau AccessKey ID. `password`: Opsional. Kata sandi untuk akun database. `resource`: Menentukan jenis VPC. Parameter ini diperlukan jika Anda menggunakan koneksi VPC. Jika sumber data dibuat dengan pengaturan VPC, Anda harus menyertakan parameter ini dalam permintaan pembaruan Anda. Menghilangkan parameter ini dari permintaan akan menonaktifkan koneksi VPC. Untuk daftar nilai `resource`, lihat bagian Informasi tambahan di bawah. `accessId`: Opsional. AccessKey ID untuk instance VPC. Parameter ini diperlukan jika parameter `resource` ditentukan. `accessKey`: Opsional. AccessKey secret untuk instance VPC. Parameter ini diperlukan jika parameter `resource` ditentukan. `instanceId`: Opsional. ID instance VPC. Parameter ini diperlukan jika parameter `resource` ditentukan. `region`: Opsional. Region tempat instance VPC berada. Parameter ini diperlukan jika parameter `resource` ditentukan. Untuk daftar ID region, lihat bagian Informasi tambahan di bawah. `config`: Opsional. Objek JSON yang berisi parameter konfigurasi tambahan untuk database. Anda hanya perlu menyertakan kolom yang ingin diperbarui. Setiap kolom yang Anda sertakan akan diperbarui ke nilai baru, bahkan jika nilainya berupa string kosong. Kolom yang tidak disertakan dalam permintaan akan tetap tidak berubah.	{ "schema": "schema", "userId":"S***46345", "password": "Ta34", "showName": "test", "address": "11*.55", "instance": "quickbi_test", "dsId": "34d6d****3ca8ac267", "port": "3306", "dsType": "mysql", "username": "root", "config": { "initialSql": "Set timezone = '-10'" } }

Contoh kode @Test

public void UpdateDataSource () throws SDKException, ClientException {
    UpdateDataSourceRequest request = new UpdateDataSourceRequest();
    HashMap<String,Object> updateModel = new HashMap<>();
    updateModel.put("dsId", "342e*******455");
    updateModel.put("userId","74f5*****20ebf278c8");
    updateModel.put("dsType", "impala");
    updateModel.put("address", "12***22");
    updateModel.put("instance", "default");
    updateModel.put("showName", "wk***_update");
    request.setUpdateModel(JSONObject.toJSONString(updateModel));
    System.out.println(JSONObject.toJSONString(updateModel));
    request.setSysConnectTimeout(60000);request.setSysReadTimeout(60000);
    UpdateDataSourceResponse  acsResponse = getPopAPIClient("test").getAcsResponse(request);

    System.out.println(JSONObject.toJSONString(acsResponse.getResult()));
}

Informasi tambahan

Pemetaan resource
Tabel berikut mencantumkan nilai resource untuk jenis sumber data umum. Jika sumber data Anda mendukung koneksi VPC tetapi tidak tercantum, Anda dapat menemukan nilai resource-nya menggunakan developer tools di browser Anda. Periksa permintaan jaringan yang dibuat ke endpoint API detect saat Anda mengklik Test Connection di editor sumber data. Nilainya ada di kolom config.resource pada payload permintaan.

Layanan Alibaba Cloud (seperti ApsaraDB RDS): rds
AnalyticDB for MySQL: adb
AnalyticDB for PostgreSQL: gpdb
Hologres: hologres
ClickHouse: clickhouse
E-MapReduce Serverless StarRocks: starrocks
PolarDB for MySQL: polardb
PolarDB-X: drds
PolarDB for PostgreSQL: polardb
PolarDB for PostgreSQL (Kompatibel Oracle): polardb
SelectDB: selectdb
OceanBase: oceanbase
Lindorm: lindorm
Alibaba HybridDB for MySQL: petaData
HBase: hbase
Sumber data yang dikelola sendiri dan sumber data Huawei Cloud: ecs
AWS, Microsoft Azure, Tencent Cloud, dan Google Cloud: rds
TDSQL-H LibraDB: tdsql
Dataphin: api_gateway

Pemetaan region

China (Qingdao): cn-qingdao
China (Beijing): cn-beijing
China (Zhangjiakou): cn-zhangjiakou
China (Hohhot): cn-huhehaote
China (Ulanqab): cn-wulanchabu
China (Hangzhou): cn-hangzhou
China (Shanghai): cn-shanghai
China (Nanjing-Local Region): cn-nanjing
China (Shenzhen): cn-shenzhen
China (Heyuan): cn-heyuan
China (Guangzhou): cn-guangzhou
China (Fuzhou-Local Region): cn-fuzhou
China (Wuhan-Local Region): cn-wuhan-lr
China (Chengdu): cn-chengdu
China (Hong Kong): cn-hongkong
Jepang (Tokyo): ap-northeast-1
Korea (Seoul): ap-northeast-2
Singapura: ap-southeast-1
Malaysia (Kuala Lumpur): ap-southeast-3
Filipina (Manila): ap-southeast-6
Indonesia (Jakarta): ap-southeast-5
Thailand (Bangkok): ap-southeast-7
AS (Virginia): us-east-1
AS (Silicon Valley): us-west-1
Meksiko (Queretaro): na-south-1
Inggris (London): eu-west-1
UEA (Dubai): me-east-1
Jerman (Frankfurt): eu-central-1

Elemen respons

Element	Type	Description	Example
	object	Kontainer untuk data yang dikembalikan.
RequestId	string	ID permintaan.	D787E1A***********5DF8D885
Result	boolean	Hasil operasi. Nilai yang valid: `true`: Operasi berhasil. `false`: Operasi gagal.	true
Success	boolean	Menunjukkan apakah permintaan berhasil. Nilai yang valid: `true`: Permintaan berhasil. `false`: Permintaan gagal.	true

Contoh

Respons sukses

JSONformat

{
  "RequestId": "D787E1A***********5DF8D885",
  "Result": true,
  "Success": true
}

Kode kesalahan

HTTP status code	Error code	Error message
400	Internal.System.Error	An internal system error occurred.
400	Invalid.Parameter.Error	The parameter is invalid:%s.
400	User.NotIn.Workspace	The user is not a member of the group workspace.
400	NoPermissionTo.Operate.Object	You are not authorized to operate the objects.
400	DatasourceId.IsNull.Error	You must select a data source before selecting the table.
400	Datasource.NotFound.Error	The specified data source does not exist: %s.
400	Name.RegularExpression.Error	Name format validation failed.
400	NameExceeded.MaxLength.Error	The name cannot exceed %s characters in length.
400	Database.PortInvalid.Error	The database port is invalid.
400	VpcInstance.Info.Error	Get vpc instance info error.please check vpc config %s.
400	VpcInstance.Info.EmptyError	Not found instance. please check vpc config and authorization %s.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.