すべてのプロダクト
Search

このプロダクト

    :GetDataSourceConnectionInfo

    ドキュメントセンター

    :GetDataSourceConnectionInfo

    最終更新日:Dec 24, 2025

    データソース情報を取得

    今すぐお試しください

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

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    quickbi-public:GetDataSourceConnectionInfo

    get

    *All Resource

    *

    		 なし なし

    リクエスト構文

    POST  HTTP/1.1

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DsId

    string

    必須

    データソース ID。

    7AAB95D-*****-****-*4FC0C976

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

    7AAB95D-*****-****-*4FC0C976
    Result

    object

    データソース情報。

    Address

    string

    データベース接続文字列アドレス (ドメインまたは IP)。

    172.**.**.48
    AuthLevel

    string

    権限レベル：

    • 0 -- プライベート

    • 1 -- 共同編集 (旧)

    • 11 -- 共同編集 - スペースメンバー

    • 12 -- 共同編集 - 個人に指定

    0
    CreatorId

    string

    作成者の Quick BI ユーザー ID。

    U240****0880C6095
    DsId

    string

    データソース ID。

    a201c85c-******
    DsType

    string

    データソースタイプ。

    列挙値:

    • hive :

      Hive データソース

    • vertica :

      Vertica データソース

    • ppas :

      RDS PPAS データソース

    • dm :

      DM7 データソース-Dameng

    • tsdb :

      TSDB データソース

    • tdsql :

      TDSQL-H データソース

    • mysql_hybrid :

      HybridDB for MySQL データソース

    • sqlserver :

      sqlserver データソース

    • postgresql :

      postgresql データソース

    • garuda :

      garuda データソース

    • adb_spark :

      adb データソース Spark エンジン

    • greenplum :

      greenplum データソース

    • phoenix_thin :

      PHOENIX THIN データソース

    • dla :

      DataLake Analytics データソース

    • starrocks :

      StarRocks データソース

    • mysql :

      mysql データソース

    • hana :

      SAP HANA データソース

    • mongodb :

      MongoDB データソース

    • adb :

      ADB

    • hbase :

      HBASE データソース

    • oscar :

      Sheng Tong データソース

    • gbase :

      Gbase データソース

    • oracle :

      oracle データソース

    • sybase :

      SAP SYBASE IQ データソース

    • dataphin :

      DataPhin データソース-マルチエンジン

    • odps :

      odps データソース

    • db2 :

      IBM DB2 データソース (LUW)

    • yida :

      yida アプリケーションデータソース

    • clickhouse :

      ClickHouse データソース

    • oceanbase_oracle :

      OceanBase_Oracle データソース

    • presto :

      presto データソース

    • polardb :

      polardb データソース

    • dataphin_odps :

      DataPhin データソース odps エンジン

    • selectdb :

      SelectDB データソース

    mysql
    DsVersion

    string

    データソースのバージョン。

    5.7
    Instance

    string

    データベースインスタンス。データベース名に対応します。ODPS の場合はプロジェクトです。

    rm*********t44ju1
    InstanceId

    string

    インスタンス ID。

    rm*********t44ju1
    ModifyUser

    string

    変更者の Quick BI ユーザー ID。

    U240****0880C6095
    NoSasl

    boolean

    impala データソースがログインに認証を必要とするかどうか：

    • true - アカウントとパスワードによるログインが必要

    • false - 認証は不要 (デフォルト)

    true
    ParentDsType

    string

    マルチエンジンデータソースのプライマリデータソースタイプ。

    dataphin
    Port

    string

    ポート。

    3306
    Project

    string

    ODPS の接続詳細を取得する際に、フロントエンド表示に使用されます。

    prod-ossdoc
    Schema

    string

    データベーススキーマ。スキーマをサポートするデータベースに対してのみ設定する必要があります。

    Analysis
    ShowName

    string

    フロントエンドに表示されるデータソースの表示名。

    0327
    WorkspaceId

    string

    データソースが属するワークスペース ID。

    0de6**2-d**-4720-8836-0cc****1394c
    Success

    boolean

    操作が成功したかどうかを示します。

    true

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "7AAB95D-*****-****-*4FC0C976",
  "Result": {
    "Address": "172.**.**.48",
    "AuthLevel": "0",
    "CreatorId": "U240****0880C6095",
    "DsId": "a201c85c-******",
    "DsType": "mysql",
    "DsVersion": "5.7",
    "Instance": "rm*********t44ju1",
    "InstanceId": "rm*********t44ju1",
    "ModifyUser": "U240****0880C6095",
    "NoSasl": true,
    "ParentDsType": "dataphin",
    "Port": "3306",
    "Project": "prod-ossdoc",
    "Schema": "Analysis",
    "ShowName": "0327",
    "WorkspaceId": "0de6**2-d**-4720-8836-0cc****1394c"
  },
  "Success": true
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 Invalid.Parameter The length of the parameter must not exceed 1000.
    400 Access.Forbidden Your instance version or access key is not allowed to call the API operation, only professional version supports calling.
    400 Internal.System.Error An internal system error occurred.
    400 Instance.Expired Your instance has expired.
    400 Instance.Not.Exist The specified instance does not exist.
    400 Invalid.Organization The specified organizational unit does not exist.
    400 User.Not.In.Organization The specified user is not in the organizational unit.
    400 Invalid.Param.Error The parameter is invalid.
    400 Invalid.Parameter.Error The parameter is invalid:%s.
    400 Datasource.NotFound.Error The specified data source does not exist: %s.
    400 Application.Object.NotExist The object you are operating does not exist or has been deleted.

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

    変更履歴

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