すべてのプロダクト
Search

このプロダクト

    :DescribeParentInstance

    ドキュメントセンター

    :DescribeParentInstance

    最終更新日:Sep 15, 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    yundun-sddp:DescribeParentInstance

    list

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    CurrentPage

    integer

    任意

    ページングクエリで返すページ番号。デフォルト値: 1。

    1
    PageSize

    integer

    任意

    ページングクエリで各ページに返すエントリ数。デフォルト値: 10。

    10
    ServiceRegionId

    string

    任意

    資産が存在するリージョン。有効な値:

    • cn-beijing: 中国 (北京)。

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

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

    • cn-hangzhou: 中国 (杭州)。

    • cn-shanghai: 中国 (上海)。

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

    • cn-hongkong: 中国 (香港)。

    cn-shanghai
    EngineType

    string

    任意

    データベースエンジンのタイプ。有効な値:

    • MySQL。

    • MariaDB。

    • Oracle。

    • PostgreSQL。

    • SQLServer。

    MySQL
    InstanceId

    string

    任意

    データ資産インスタンスの ID。

    rm-*******xx
    DbName

    string

    任意

    データベースの名前。

    db_**t
    ResourceType

    integer

    任意

    このパラメーターは必須です。プロダクトのタイプ。有効な値:

    • 1: MaxCompute

    • 2: OSS

    • 3: ADB-MYSQL

    • 4: TableStore

    • 5: RDS

    • 6: セルフマネージドデータベース

    • 7: PolarDB-X

    • 8: PolarDB

    • 9: ADB-PG

    • 10: OceanBase

    • 11: MongoDB

    • 25: Redis

    5
    CheckStatus

    integer

    任意

    インスタンスまたはインスタンス内のデータベースの接続ステータス。有効な値:

    • -3: データベースが作成されていません。

    • -2: リリース済み。

    • -1: 未接続。

    • 2: 接続性をテスト中。

    • 3: 接続済み。

    • 4: 接続に失敗しました。

    3
    ClusterStatus

    string

    任意

    インスタンスのステータス。

    • Running: 実行中。

    • Released: リリース済み。

    • DatabaseNotCreated: データベースが作成されていません。

    Running
    AuthStatus

    integer

    任意

    データ資産インスタンスの権限付与ステータス。

    • 0: 権限付与されていません。

    • 1: 権限付与済み。

    0
    MemberAccount

    integer

    任意

    メンバーアカウントの ID。

    **********8103
    Lang

    string

    任意

    リクエストとレスポンス内のコンテンツの言語。有効な値:

    • zh_cn: 簡体字中国語。これはデフォルト値です。

    • en_us: 米国英語。

    zh_cn

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスのスキーマ

    RequestId

    string

    リクエストの ID。

    ACEF9334-BB50-525D-8CF3-6CF504E4D1B3
    CurrentPage

    integer

    返されたページのページ番号。デフォルト値: 1。

    1
    PageSize

    integer

    各ページで返されるデータ資産インスタンスの最大数。デフォルト値: 10。

    10
    TotalCount

    integer

    返されたエントリの総数。

    3
    Items

    array<object>

    クエリされたデータ資産のリスト。

    object

    クエリされた資産の詳細。

    InstanceId

    string

    インスタンス ID。

    rm-*******t2vz
    LocalName

    string

    リージョンの名前。有効な値は次のとおりです:

    • 中国 (杭州)

    • 中国 (上海)

    • 中国 (北京)

    • 中国 (張家口)

    • 中国 (深セン)

    • 中国 (広州)

    • 中国 (香港)

    • シンガポール

    • 米国 (シリコンバレー)

    华东1（杭州）
    EngineType

    string

    データベースエンジンのタイプ。有効な値:

    • MySQL。

    • MariaDB。

    • Oracle。

    • PostgreSQL。

    • SQLServer。

    MySQL
    ParentId

    string

    権限付与された資産の識別子。資産が構造化データの場合、識別子は `インスタンス ID.データベース名` のフォーマットになります。

    rm-******xxx.**st
    DbNum

    string

    インスタンス内のデータベースの数。

    3
    ClusterStatus

    string

    インスタンスのステータス。

    Running
    TenantId

    string

    テナント ID。このパラメーターは OceanBase 資産に対してのみ有効です。

    HB***-zh_CN
    TenantName

    string

    テナント名。このパラメーターは OceanBase 資産に対してのみ有効です。

    user1
    InstanceDescription

    string

    インスタンスの説明。

    instance description
    ResourceType

    string

    資産タイプの名前。有効な値:

    • MaxCompute

    • OSS

    • ADB-MYSQL

    • TableStore

    • RDS

    • SelfDB

    • PolarDB-X

    • PolarDB

    • ADB-PG

    • OceanBase

    • MongoDB

    • Redis

    RDS
    UnConnectDbCount

    string

    インスタンス内の未接続のデータベースの数。

    1
    UnSupportOneClickAuthReason

    string

    ワンクリック権限付与がサポートされていない理由。

    engine type not support
    ConnectNode

    string

    接続ノードのタイプ。このパラメーターは MongoDB 資産に対してのみ有効です。

    Primary
    SupportConnectNodes

    string

    サポートされている接続ノード。複数のノードはカンマで区切られます。

    Primary,Secondary
    AuthStatus

    integer

    データ資産インスタンスの権限付与ステータス。

    • 0: 権限付与されていません。

    • 1: 権限付与済み。

    1
    InstanceSize

    integer

    インスタンスのストレージ容量。このパラメーターは OSS 資産に対してのみ有効です。単位: バイト。

    409600
    AuditStatus

    integer

    監査権限付与ステータス。有効な値:

    • 1: 権限付与済み。

    • 0: 権限付与されていません。

    1
    MemberAccount

    integer

    メンバーアカウントの ID。

    **********8103
    AuthTime

    integer

    インスタンスが権限付与された時間。単位: ミリ秒。

    1719882941000
    RegionId

    string

    資産が存在するリージョン。

    cn-hangzhou

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "ACEF9334-BB50-525D-8CF3-6CF504E4D1B3",
  "CurrentPage": 1,
  "PageSize": 10,
  "TotalCount": 3,
  "Items": [
    {
      "InstanceId": "rm-*******t2vz",
      "LocalName": "华东1（杭州）",
      "EngineType": "MySQL",
      "ParentId": "rm-******xxx.**st",
      "DbNum": "3",
      "ClusterStatus": "Running",
      "TenantId": "HB***-zh_CN",
      "TenantName": "user1",
      "InstanceDescription": "instance description",
      "ResourceType": "RDS",
      "UnConnectDbCount": "1",
      "UnSupportOneClickAuthReason": "engine type not support",
      "ConnectNode": "Primary",
      "SupportConnectNodes": "Primary,Secondary",
      "AuthStatus": 1,
      "InstanceSize": 409600,
      "AuditStatus": 1,
      "MemberAccount": 0,
      "AuthTime": 1719882941000,
      "RegionId": "cn-hangzhou"
    }
  ]
}

    エラーコード

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

    変更履歴

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