すべてのプロダクト
Search

このプロダクト

    Data Management:GetTableDesignProjectInfo

    ドキュメントセンター

    Data Management:GetTableDesignProjectInfo

    最終更新日:Mar 21, 2026

    スキーマ設計チケットのプロジェクト情報および変更ベースデータベース情報を照会します。たとえば、チケットの状態、チケットを作成したユーザーの ID、変更ベースデータベースの名前および ID などが含まれます。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    dms:GetTableDesignProjectInfo

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    OrderId

    integer

    必須

    スキーマ設計チケットの ID です。この ID を取得するには、ListOrders 操作を呼び出します。

    95****
    Tid

    integer

    任意

    テナント ID です。

    説明

    テナント ID を確認するには、Data Management (DMS) コンソールにログインし、右上隅のプロフィール画像にマウスポインターを合わせます。詳細については、「DMS テナントの管理」トピック内の「現在のテナントに関する情報を表示する」セクションをご参照ください。

    3***

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスパラメーターです。

    RequestId

    string

    リクエスト ID です。この ID を使用してログを照会したり、問題のトラブルシューティングを行ったりできます。

    48778434-5796-571A-8455-A59146588401
    Success

    boolean

    リクエストが成功したかどうかを示します。有効な値は以下のとおりです。

    • true

    • false

    true
    ErrorMessage

    string

    リクエストが失敗した場合に返されるエラーメッセージです。

    UnknownError
    ErrorCode

    string

    リクエストが失敗した場合に返されるエラーコードです。

    UnknownError
    ProjectInfo

    object

    スキーマ設計プロジェクトに関する情報です。

    OrderId

    integer

    チケット ID です。

    95****
    ProjectId

    integer

    プロジェクト ID です。

    12****
    GmtCreate

    string

    チケットが作成された時刻です。

    2024-04-23 02:57:01
    GmtModified

    string

    チケットが最後に変更された時刻です。

    2024-04-23 02:57:01
    Status

    string

    スキーマ設計プロジェクトの状態です。有効な値は以下のとおりです。

    • DESIGN: スキーマが設計中です。

    • PUBLISHED: スキーマが公開されています。

    • CLOSE: チケットがクローズされています。

    DESIGN
    Title

    string

    スキーマ設計プロジェクトの名称です。

    用户增长战役
    Description

    string

    スキーマ設計プロジェクトの説明です。

    测试
    CreatorId

    integer

    チケットを作成したユーザーの ID です。

    71****
    BaseDatabase

    object

    スキーマ設計チケットの変更ベースデータベースに関する情報です。

    SearchName

    string

    データベースを検索するために使用する名前です。

    schema_name@127.0.XX.XX
    SchemaName

    string

    データベース名です。

    bk_atc020
    DbId

    integer

    データベース ID です。

    11****
    Logic

    boolean

    データベースが論理データベースであるかどうかを示します。有効な値は以下のとおりです。

    • true

    • false

    false
    Alias

    string

    データベースインスタンスのエイリアスです。

    核心交易库
    EnvType

    string

    データベースインスタンスがデプロイされている環境の種類です。有効な値は以下のとおりです。

    • product: 本番環境

    • dev: 開発環境

    • pre: プレリリース環境

    • test: テスト環境

    • sit: 統合テスト (SIT) 環境

    • uat: 受け入れテスト (UAT) 環境

    • pet: ストレステスト環境

    • stag: ステージング環境

    dev
    DbType

    string

    データベースの種類です。このパラメーターの有効な値については、「DbType パラメーター」をご参照ください。

    POLARDB

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "48778434-5796-571A-8455-A59146588401",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "ProjectInfo": {
    "OrderId": 0,
    "ProjectId": 0,
    "GmtCreate": "2024-04-23 02:57:01",
    "GmtModified": "2024-04-23 02:57:01",
    "Status": "DESIGN",
    "Title": "用户增长战役",
    "Description": "测试",
    "CreatorId": 0,
    "BaseDatabase": {
      "SearchName": "schema_name@127.0.XX.XX",
      "SchemaName": "bk_atc020",
      "DbId": 0,
      "Logic": false,
      "Alias": "核心交易库",
      "EnvType": "dev",
      "DbType": "POLARDB"
    }
  }
}

    エラーコード

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

    変更履歴

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