すべてのプロダクト
Search

このプロダクト

    PolarDB:DescribePolarFsAttribute

    ドキュメントセンター

    PolarDB:DescribePolarFsAttribute

    最終更新日:Sep 24, 2026

    Polarlakebase インスタンスの詳細を照会します。

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    polardb:DescribePolarFsAttribute

    get

    *LakeCache。

    acs:polardb:{#regionId}:{#accountId}:lakecache/{#PolarFsInstanceId}

    		 なし なし

    リクエスト構文

    GET  HTTP/1.1

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    PolarFsInstanceId

    string

    必須

    Polarlakebase インスタンスの ID。

    pfs-2ze0i74ka607*****
    QueryFuseMountInfo

    boolean

    任意

    Fuse マウント情報を照会するかどうかを指定します。有効な値:

    • true: はい。

    • false: いいえ。これがデフォルト値です。

    false
    DBClusterId

    string

    任意

    クラスターの ID。

    説明

    DescribeDBClusters 操作を呼び出して、クラスター ID を含むアカウントのすべてのクラスターの詳細を照会できます。

    pc-bp1q76364ird*****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスのスキーマ。

    RequestId

    string

    リクエストの ID。

    3F9E6A3B-C13E-4064-A010-18582A******
    RelativeDbClusterId

    string

    関連付けられた PolarDB クラスターの ID。

    pc-2zejpr41d9xk3uk34
    PolarFsInstanceId

    string

    Polarlakebase インスタンスの ID。

    pfs-2ze0i74ka607*****
    PolarFsStatus

    string

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

    Running
    PolarFsVersion

    string

    バージョン。

    1.0.1-1.0.3
    PayType

    string

    課金方法。有効な値:

    • Postpaid: 従量課金。

    • Prepaid: サブスクリプション。

    Prepaid
    DBType

    string

    データベースエコシステムタイプ。有効な値:

    • MySQL

    • PostgreSQL

    MySQL
    PolarFsInstanceDescription

    string

    Polarlakebase インスタンスの説明。

    pfs-xxx
    RegionId

    string

    リージョン ID。

    cn-beijing
    ZoneId

    string

    vSwitch のゾーン ID。

    cn-beijing-k
    VPCId

    string

    VPC ID。

    vpc-**********
    VSwitchId

    string

    vSwitch ID。

    vsw-**************
    SecurityGroupId

    string

    マネージドセキュリティグループの ID。

    sg-bp**************
    CreateTime

    string

    作成時間。 時間は、ISO 8601 フォーマットの協定世界時 (UTC) (フォーマット: YYYY-MM-DDTHH:mm:ssZ) です。

    2021-08-02T05:57:10Z
    ExpireTime

    string

    クラスターの有効期限。 このパラメーターは、課金方法が Prepaid (サブスクリプション) のクラスターに対してのみ返されます。Postpaid (従量課金) のクラスターの場合は空の値が返されます。 時間は、ISO 8601 フォーマットの協定世界時 (UTC) (フォーマット: YYYY-MM-DDTHH:mm:ssZ) です。

    2025-10-10T16:00:00Z
    Expired

    string

    クラスターが期限切れかどうかを示します。 このパラメーターは、課金方法が Prepaid (サブスクリプション) のクラスターに対してのみ返されます。

    false
    PolarFsType

    string

    インスタンスのバージョン。有効な値:

    • PolarFS 2.0: 2.0。

    • PolarFS 1.0: 1.0。

    PolarFS 2.0
    StorageSpace

    number

    ストレージ容量。単位: GB。

    1000
    StorageUsed

    number

    使用済みストレージ容量。単位: バイト。

    3012558848
    Bandwidth

    number

    帯域幅。単位: MB/s。

    100
    BandwidthBaseLine

    number

    帯域幅のベースライン。単位: MB/s/TiB。

    100
    Category

    string

    Polarlakebase のエディション。有効な値:

    • high_performance: High-performance Edition。

    • basic: Basic Edition。

    • cold: Cold Storage Edition。

    high_performance
    LockMode

    string

    ロックモード。有効な値:

    • Unlock: ロック済みではありません。

    • ManualLock: 手動でロック済み。

    • LockByExpiration: クラスターの有効期限切れにより自動的にロック済み。

    Unlock
    StorageType

    string

    High-performance エディションのストレージタイプ。有効な値:

    • ESSDPL1

    • ESSDPL0

    Basic Edition のストレージタイプ。有効な値:

    • city_redundancy: ゾーン冗長ストレージ。

    essdpl1
    AcceleratingEnable

    string

    高速化キャッシュが有効かどうかを示します。有効な値:

    • ON: 有効。

    • OFF: 無効。

    ON
    AcceleratedStorageSpace

    number

    高速化ストレージ容量。単位: GB。

    1000
    MountInfo

    object

    マウント構成。

    PolarFsCluster

    string

    ファイルシステム名。

    pfs-**********
    Token

    string

    トークン値。

    a734298c391cb9ebd05e2ee85feb624
    PolarDbProxy

    string

    クラスター管理エンドポイント。

    TCP://**.**.**.**:3000,TCP://**.**.**.**:3000,TCP://**.**.**.**:3000
    MinorVersion

    string

    インスタンスのマイナーバージョン。

    v1.3.0-v1.1.1
    ClientDownloadPath

    string

    クライアントのダウンロード URL。

    oss://*
    MetaUrl

    string

    Fuse マウント用のメタデータアドレス (暗号化済み)。

    e6cc1d2e2a6fa292038d999fda6501*****
    RelativePfsClusterId

    string

    関連付けられた Polarlakebase インスタンスのインスタンス ID。

    pfs-**********
    BucketId

    string

    バケット ID。

    xxx
    FileSystemId

    string

    ファイルシステム ID。

    xxx
    CustomBucketPath

    string

    カスタムバケットパス。

    xxxxxx-%d.oss-cn-beijing-internal.aliyuncs.com
    AccelerateType

    string

    高速化タイプ。

    alluxio
    CustomBucketPathList

    array<object>

    カスタムストレージパスのリスト。

    object

    カスタムストレージ情報。

    Bucket

    string

    カスタムストレージバケット。

    pfs-xxx.oss-[リージョンID]-internal.aliyuncs.com
    Path

    string

    カスタムストレージパス。

    /data
    MetaInstanceName

    string

    メタデータインスタンス名。

    pc-xxxxxxxxxxxxxxxxx
    DBEndpointId

    string

    エンドポイント ID。

    pe-zo1z5qw5nb39s699n
    MaxscaleEndpointId

    string

    プロキシエンドポイント ID。

    pe-cz9inwqec7ifd98c3
    MetaConnString

    string

    メタデータサービスのクラスターエンドポイント。

    pc-x67w12d2d5t13mt88.pg.polardb.rds.aliyuncs.com
    MetaMxsConnString

    string

    メタデータプロキシサービスのクラスターエンドポイント。

    pc-y3610mp168p3bb740.rwlb.rds.aliyuncs.com
    EndpointItems

    array<object>

    エンドポイントのリスト。NAS や S3 ゲートウェイなどのタイプのエンドポイント情報が含まれます。

    array<object>

    DBEndpointId

    string

    エンドポイント ID。

    ep-xxxxxxxxx
    EndpointType

    string

    エンドポイントタイプ。有効な値: NAS、S3 ゲートウェイなど。

    S3Gateway
    AddressItems

    array<object>

    アドレスのリスト。

    object

    ConnectionString

    string

    プロトコルエンドポイント。

    aclsh-prd-pdb12-rw.rwlb.rds.aliyuncs.com
    IPAddress

    string

    IP アドレス。

    47.116.9.224
    Port

    string

    ポート番号。

    3306
    VPCId

    string

    VPC ID。

    vpc-**********
    VSwitchId

    string

    vSwitch ID。

    vsw-**************
    NetType

    string

    接続文字列のネットワークタイプ。有効な値:

    • Public: パブリックエンドポイント。

    • Private: プライベートエンドポイント。

    • Inner: プライベートエンドポイント (クラシックネットワーク)。

    Public
    UserDefaultAccName

    string

    S3 ゲートウェイのデフォルトユーザーアカウント名。

    lakebase_acc
    UserDefaultAccSk

    string

    S3 ゲートウェイのデフォルトユーザーアカウントキー (暗号化された暗号文)。

    EncryptedSecretKey==
    AuthorizedUserIds

    string

    許可された UID のリスト (カンマ区切り)。

    1234567890,9876543210
    AuthorizedUserArnIds

    string

    許可された RAM ロール ARN のリスト (カンマ区切り)。

    arn:sts::123456:assumed-role/myロール/*

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "3F9E6A3B-C13E-4064-A010-18582A******",
  "RelativeDbClusterId": "pc-2zejpr41d9xk3uk34",
  "PolarFsInstanceId": "pfs-2ze0i74ka607*****",
  "PolarFsStatus": "Running",
  "PolarFsVersion": "1.0.1-1.0.3",
  "PayType": "Prepaid",
  "DBType": "MySQL",
  "PolarFsInstanceDescription": "pfs-xxx",
  "RegionId": "cn-beijing",
  "ZoneId": "cn-beijing-k",
  "VPCId": "vpc-**********",
  "VSwitchId": "vsw-**************",
  "SecurityGroupId": "sg-bp**************",
  "CreateTime": "2021-08-02T05:57:10Z",
  "ExpireTime": "2025-10-10T16:00:00Z",
  "Expired": "false",
  "PolarFsType": "PolarFS 2.0",
  "StorageSpace": 1000,
  "StorageUsed": 3012558848,
  "Bandwidth": 100,
  "BandwidthBaseLine": 100,
  "Category": "high_performance",
  "LockMode": "Unlock",
  "StorageType": "essdpl1",
  "AcceleratingEnable": "ON",
  "AcceleratedStorageSpace": 1000,
  "MountInfo": {
    "PolarFsCluster": "pfs-**********",
    "Token": "a734298c391cb9ebd05e2ee85feb624",
    "PolarDbProxy": "TCP://**.**.**.**:3000,TCP://**.**.**.**:3000,TCP://**.**.**.**:3000"
  },
  "MinorVersion": "v1.3.0-v1.1.1",
  "ClientDownloadPath": "oss://*",
  "MetaUrl": "e6cc1d2e2a6fa292038d999fda6501*****",
  "RelativePfsClusterId": "pfs-**********",
  "BucketId": "xxx",
  "FileSystemId": "xxx",
  "CustomBucketPath": "xxxxxx-%d.oss-cn-beijing-internal.aliyuncs.com",
  "AccelerateType": "alluxio",
  "CustomBucketPathList": [
    {
      "Bucket": "pfs-xxx.oss-[リージョンID]-internal.aliyuncs.com",
      "Path": "/data"
    }
  ],
  "MetaInstanceName": "pc-xxxxxxxxxxxxxxxxx",
  "DBEndpointId": "pe-zo1z5qw5nb39s699n",
  "MaxscaleEndpointId": "pe-cz9inwqec7ifd98c3",
  "MetaConnString": "pc-x67w12d2d5t13mt88.pg.polardb.rds.aliyuncs.com",
  "MetaMxsConnString": "pc-y3610mp168p3bb740.rwlb.rds.aliyuncs.com",
  "EndpointItems": [
    {
      "DBEndpointId": "ep-xxxxxxxxx",
      "EndpointType": "S3Gateway",
      "AddressItems": [
        {
          "ConnectionString": "aclsh-prd-pdb12-rw.rwlb.rds.aliyuncs.com",
          "IPAddress": "47.116.9.224",
          "Port": "3306",
          "VPCId": "vpc-**********",
          "VSwitchId": "vsw-**************",
          "NetType": "Public"
        }
      ]
    }
  ],
  "UserDefaultAccName": "lakebase_acc",
  "UserDefaultAccSk": "EncryptedSecretKey==",
  "AuthorizedUserIds": "1234567890,9876543210",
  "AuthorizedUserArnIds": "arn:sts::123456:assumed-role/myrole/*"
}

    エラーコード

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

    変更履歴

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