すべてのプロダクト
Search
ドキュメントセンター

:UpdateDataSource

最終更新日:Apr 23, 2026

データソースの構成を変更します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエスト構文

POST  HTTP/1.1

リクエストパラメーター

パラメーター

必須 / 任意

説明

UpdateModel

string

必須

更新するデータソース構成を定義する JSON 形式の文字列です。具体的なフォーマットは、例をご参照ください。JSON 文字列には、次のパラメーターが含まれます:

  • dsId:必須。データソースの ID。

  • userId:任意。データソースを変更する Quick BI ユーザーの ID。このパラメーターを指定すると、このユーザーとして更新が実行されます。

  • dsType:必須。データソースのタイプ。この値は変更できず、既存のデータソースタイプと一致する必要があります。

  • showName:任意。データソースの表示名。

  • address:任意。データベース接続エンドポイント。ドメイン名または IP アドレスを指定できます。

  • port:任意。データベースの接続ポート。

  • schema:任意。データベーススキーマ。このパラメーターは、スキーマをサポートするデータベースタイプでのみ必須です。例えば、SQL Server のデフォルトスキーマは dbo ですが、MySQL はスキーマを使用しません。

  • instance:任意。データベースインスタンス。

  • username:任意。データベースアカウントのユーザー名または AccessKey ID。

  • password:任意。データベースアカウントのパスワード。

  • resource:VPC タイプを指定します。VPC 接続を使用している場合、このパラメーターは必須です。データソースが VPC 設定で作成された場合、更新リクエストにこのパラメーターを含める必要があります。リクエストからこのパラメーターを省略すると、VPC 接続が無効になります。resource の値のリストについては、後述の「補足情報」セクションをご参照ください。

  • accessId:任意。VPC インスタンスの AccessKey ID。resource パラメーターが指定されている場合は必須です。

  • accessKey:任意。VPC インスタンスの AccessKey Secret。resource パラメーターが指定されている場合は必須です。

  • instanceId:任意。VPC インスタンスの ID。resource パラメーターが指定されている場合は必須です。

  • region:任意。VPC インスタンスが配置されているリージョン。resource パラメーターが指定されている場合は必須です。リージョン ID のリストについては、後述の「補足情報」セクションをご参照ください。

  • config:任意。データベースの追加構成パラメーターを含む JSON オブジェクト。更新したいフィールドのみを含める必要があります。含めたフィールドは、空の文字列であっても新しい値に更新されます。リクエストに含まれていないフィールドは変更されません。

{ "schema": "schema", "userId":"S*****46345", "password": "Ta****34", "showName": "test", "address": "11*****.55", "instance": "quickbi_test", "dsId": "34d6d******3ca8ac267", "port": "3306", "dsType": "mysql", "username": "root", "config": { "initialSql": "Set timezone = '-10'" } }

コード例 @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()));
}

補足情報

リソースマッピング
次の表に、一般的なデータソースタイプに対応する resource の値を示します。ご利用のデータソースが VPC 接続をサポートしているにもかかわらず、この表に記載されていない場合は、ブラウザの開発者ツールを使用してリソース値を確認できます。データソースエディターで [接続テスト] をクリックしたときに送信される detect API エンドポイントへのネットワークリクエストを調査してください。値はリクエストペイロードの config.resource フィールドにあります。







  • Alibaba Cloud サービス (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 (Oracle Compatible):polardb

  • SelectDB:selectdb

  • OceanBase:oceanbase

  • Lindorm:lindorm

  • Alibaba HybridDB for MySQL:petaData

  • HBase:hbase

  • 自己管理データソースおよび Huawei Cloud データソース:ecs

  • AWS、Microsoft Azure、Tencent Cloud、Google Cloud:rds

  • TDSQL-H LibraDB:tdsql

  • Dataphin:api_gateway

リージョンマッピング

  • 中国 (青島):cn-qingdao

  • 中国 (北京):cn-beijing

  • 中国 (張家口):cn-zhangjiakou

  • 中国 (フフホト):cn-huhehaote

  • 中国 (ウランチャブ):cn-wulanchabu

  • 中国 (杭州):cn-hangzhou

  • 中国 (上海):cn-shanghai

  • 中国 (南京-ローカルリージョン):cn-nanjing

  • 中国 (深セン):cn-shenzhen

  • 中国 (河源):cn-heyuan

  • 中国 (広州):cn-guangzhou

  • 中国 (福州-ローカルリージョン):cn-fuzhou

  • 中国 (武漢-ローカルリージョン):cn-wuhan-lr

  • 中国 (成都):cn-chengdu

  • 中国 (香港):cn-hongkong

  • 日本 (東京):ap-northeast-1

  • 韓国 (ソウル):ap-northeast-2

  • シンガポール:ap-southeast-1

  • マレーシア (クアラルンプール):ap-southeast-3

  • フィリピン (マニラ):ap-southeast-6

  • インドネシア (ジャカルタ):ap-southeast-5

  • タイ (バンコク):ap-southeast-7

  • 米国 (バージニア):us-east-1

  • 米国 (シリコンバレー):us-west-1

  • メキシコ (ケレタロ):na-south-1

  • イギリス (ロンドン):eu-west-1

  • UAE (ドバイ):me-east-1

  • ドイツ (フランクフルト):eu-central-1

レスポンスフィールド

フィールド

説明

object

返されるデータが格納されるコンテナ。

RequestId

string

リクエスト ID。

D787E1A***********5DF8D885

Result

boolean

操作の結果。有効な値:

  • true:操作は成功しました。

  • false:操作は失敗しました。

true

Success

boolean

リクエストが成功したかどうかを示します。有効な値:

  • true:リクエストは成功しました。

  • false:リクエストは失敗しました。

true

成功レスポンス

JSONJSON

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

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

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. 指定されたデータソースは存在しません:%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.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。