すべてのプロダクト
Search

このプロダクト

    :GetInstance

    ドキュメントセンター

    :GetInstance

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    hologram:GetInstance

    get

    *Instance

    acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}

    		 なし なし

    リクエスト構文

    GET /api/v1/instances/{instanceId} HTTP/1.1

    パスパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    instanceId

    string

    任意

    インスタンス ID。このパラメーターは必須です。

    hgprecn-cn-i7m2v08uu00a

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例

    リクエストパラメーターは必要ありません。

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

    865A02C2-B374-5DD4-9B34-0CA15DA1AEBD
    Instance

    object

    インスタンスの詳細。

    InstanceChargeType

    string

    インスタンスの課金方法。

    列挙値:

    • PostPaid :

      従量課金

    • PrePaid :

      サブスクリプション

    PrePaid
    CommodityCode

    string

    商品コード。

    列挙値:

    • hologram_maxcomputeAccelerate_public_cn :

      Alibaba Cloud 中国サイト (www.aliyun.com) でのデータレイクアクセラレーション

    • hologram_combo_public_cn :

      Alibaba Cloud 中国サイト (www.aliyun.com) でのサブスクリプション

    • hologram_prepay_public_intl :

      Alibaba Cloud 国際サイト (www.alibabacloud.com) でのサブスクリプション

    • hologram_storage_dp_cn :

      Alibaba Cloud 中国サイト (www.aliyun.com) でのストレージプラン

    • hologram_postpay_public_cn :

      Alibaba Cloud 中国サイト (www.aliyun.com) での従量課金

    • hologram_postpay_public_intl :

      Alibaba Cloud 国際サイト (www.alibabacloud.com) での従量課金

    • hologram_maxcomputeAccelerate_public_intl :

      Alibaba Cloud 国際サイト (www.alibabacloud.com) でのデータレイクアクセラレーション

    • hologram_cu_dp_cn :

      Alibaba Cloud 中国サイト (www.aliyun.com) でのコンピュートプラン

    hologram_combo_public_cn
    Cpu

    integer

    CPU コア数。

    32
    CreationTime

    string

    インスタンスの作成時刻。

    2021-02-03T13:06:06Z
    Disk

    string

    標準ストレージ容量。単位：GB。

    500
    Endpoints

    array<object>

    エンドポイントのリスト。

    object

    エンドポイントの詳細。

    Endpoint

    string

    エンドポイントのドメイン名。

    hgprecn-cn-uqm362o1b001-cn-hangzhou-internal.hologres.aliyuncs.com:80
    Type

    string

    ネットワークタイプ。

    列挙値:

    • VPCSingleTunnel :

      VPC

    • Intranet :

      内部ネットワーク

    • VPCAnyTunnel :

      (新しいインスタンスではサポートされていません)

    • Internet :

      インターネット

    Internet
    Enabled

    boolean

    エンドポイントが有効かどうかを示します。

    列挙値:

    • true :

      有効

    • false :

      無効

    true
    VSwitchId

    string

    vSwitch ID。

    vsw-bp1jqwp2ys6kp7tc9t983
    VpcId

    string

    VPC ID。

    vpc-uf66jjber3hgvwhki3wna
    VpcInstanceId

    string

    VPC インスタンス ID。

    hgprecn-cn-uqm362o1b001-frontend-st
    AlternativeEndpoints

    string

    一部の古いインスタンスでは、AnyTunnel と SingleTunnel の両方が有効になっています。AnyTunnel から SingleTunnel に切り替えると、両方のエンドポイントが保持されます。このフィールドは、余分なエンドポイントを格納するために使用されます。

    hgprecn-cn-uqm362o1b001-cn-hangzhou-internal.hologres.aliyuncs.com:80
    ExpirationTime

    string

    有効期限。このパラメーターは、従量課金インスタンスの場合は返されません。

    2021-02-03T13:06:06Z
    InstanceId

    string

    インスタンス ID。

    hgpostcn-cn-tl32s6cgw00b
    InstanceName

    string

    インスタンス名。名前の長さは 2〜64 文字である必要があります。

    test
    InstanceType

    string

    インスタンスタイプ。

    列挙値:

    • Warehouse :

      コンピュートグループ

    • Follower :

      読み取り専用フォロワー

    • Standard :

      標準

    • Serverless :

      Serverless

    • Shared :

      共有

    Standard
    Memory

    integer

    メモリサイズ。単位：GB。

    128
    InstanceOwner

    string

    インスタンス所有者。

    12345678900000
    InstanceStatus

    string

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

    列挙値:

    • Creating :

      インスタンスは作成中です。

    • Running :

      インスタンスは実行中です。

    • Suspended :

      インスタンスは停止しています。

    • Allocating :

      インスタンスはリソースを割り当て中です。

    Running
    Version

    string

    インスタンスバージョン。

    r1.3.37
    SuspendReason

    string

    インスタンスが停止した理由。

    列挙値:

    • Indebet :

      支払いが延滞しています。

    • Manual :

      インスタンスは手動で停止されました。

    • Overdue :

      サブスクリプションの有効期限が切れています。

    Manual
    Tags

    array<object>

    インスタンスのタグ。

    object

    タグの詳細。

    Key

    string

    タグキー。

    tag
    Value

    string

    タグ値。

    value
    LeaderInstanceId

    string

    プライマリインスタンスの ID。

    hgpostcn-cn-i7m2ncd6w002
    EnableHiveAccess

    string

    データレイクアクセラレーションが有効かどうかを示します。

    true
    ResourceGroupId

    string

    リソースグループの ID。

    rg-aekzuq7hpybze2i
    ComputeNodeCount

    integer

    計算ノード数。ノードは通常、16 個の CPU コアと 32 GB のメモリを持ちます。

    2
    ZoneId

    string

    ゾーン ID。

    cn-hangzhou-h
    ColdStorage

    integer

    コールドストレージ容量。単位：GB。SSD はホットストレージ (標準ストレージ) を提供し、HDD はコールドストレージを提供します。

    800
    AutoRenewal

    string

    自動更新が有効かどうかを示します。

    列挙値:

    • true :

      自動更新は有効です。

    • false :

      自動更新は無効です。

    true
    GatewayCount

    integer

    ゲートウェイノードの数。

    2
    GatewayCpu

    integer

    ゲートウェイの CPU リソース。単位：コア。

    4
    GatewayMemory

    integer

    ゲートウェイのメモリリソース。単位：GB。

    16
    RegionId

    string

    リージョン ID。

    cn-hangzhou
    ReplicaRole

    string

    ディザスタリカバリシナリオにおけるインスタンスのロール。有効な値：Active、Passive、PreActive。Active：プライマリインスタンス。Passive：ディザスタリカバリインスタンス。PreActive：望ましい状態に達していないプライマリインスタンス。

    Active
    EnableServerless

    boolean

    Serverless コンピューティングが有効かどうかを示します。

    列挙値:

    • true :

      有効

    • false :

      無効

    true
    StorageType

    string

    ストレージタイプ。有効な値：

    • redundant：3 つのアベイラビリティゾーンでの冗長ストレージ

    • local：単一のアベイラビリティゾーンでのストレージ

    redundant
    EnableSSL

    boolean

    Success

    boolean

    リクエストが成功したかどうかを示します。このパラメーターはビジネスロジックとは関係ありません。

    true
    ErrorCode

    string

    エラーコード。

    null
    ErrorMessage

    string

    エラーメッセージ。

    null
    HttpStatusCode

    string

    HTTP ステータスコード。

    200

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "865A02C2-B374-5DD4-9B34-0CA15DA1AEBD",
  "Instance": {
    "InstanceChargeType": "PrePaid",
    "CommodityCode": "hologram_combo_public_cn",
    "Cpu": 32,
    "CreationTime": "2021-02-03T13:06:06Z",
    "Disk": "500",
    "Endpoints": [
      {
        "Endpoint": "hgprecn-cn-uqm362o1b001-cn-hangzhou-internal.hologres.aliyuncs.com:80",
        "Type": "Internet",
        "Enabled": true,
        "VSwitchId": "vsw-bp1jqwp2ys6kp7tc9t983",
        "VpcId": "vpc-uf66jjber3hgvwhki3wna",
        "VpcInstanceId": "hgprecn-cn-uqm362o1b001-frontend-st",
        "AlternativeEndpoints": "hgprecn-cn-uqm362o1b001-cn-hangzhou-internal.hologres.aliyuncs.com:80"
      }
    ],
    "ExpirationTime": "2021-02-03T13:06:06Z",
    "InstanceId": "hgpostcn-cn-tl32s6cgw00b",
    "InstanceName": "test",
    "InstanceType": "Standard",
    "Memory": 128,
    "InstanceOwner": "12345678900000",
    "InstanceStatus": "Running",
    "Version": "r1.3.37",
    "SuspendReason": "Manual",
    "Tags": [
      {
        "Key": "tag",
        "Value": "value"
      }
    ],
    "LeaderInstanceId": "hgpostcn-cn-i7m2ncd6w002",
    "EnableHiveAccess": "true",
    "ResourceGroupId": "rg-aekzuq7hpybze2i",
    "ComputeNodeCount": 2,
    "ZoneId": "cn-hangzhou-h",
    "ColdStorage": 800,
    "AutoRenewal": "true",
    "GatewayCount": 2,
    "GatewayCpu": 4,
    "GatewayMemory": 16,
    "RegionId": "cn-hangzhou",
    "ReplicaRole": "Active",
    "EnableServerless": true,
    "StorageType": "redundant",
    "EnableSSL": false
  },
  "Success": true,
  "ErrorCode": "null",
  "ErrorMessage": "null",
  "HttpStatusCode": "200"
}

    エラーコード

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

    変更履歴

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