すべてのプロダクト
Search
ドキュメントセンター

PolarDB:DescribePolarFs

最終更新日:Jul 03, 2026

PolarFS 情報を照会します。

今すぐお試しください

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

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエスト構文

POST  HTTP/1.1

リクエストパラメーター

パラメーター

必須 / 任意

説明

RegionId

string

必須

リージョン ID。

cn-beijing

PageSize

integer

任意

1 ページあたりのエントリ数。有効な値:

  • 30

  • 50

  • 100

30

PageNumber

integer

任意

ページ番号。値は 0 より大きく、Integer の最大値を超えない整数である必要があります。

1

PolarFsInstanceIds

string

任意

PolarFS インスタンス ID のリスト。コンマ (,) で区切ります。

pfs-ins1*******

PolarFsInstanceDescription

string

任意

PolarFS インスタンスの説明。

pfs-ins1********

RelativeDbClusterId

string

任意

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

pc-2zejpr41d9xk*****

PolarFsType

string

任意

PolarFS タイプ。

all

DBClusterId

string

任意

アプリケーションが依存する PolarDB インスタンスのインスタンス ID。

pc-2ze8u21s03******

Tag

array<object>

任意

タグ。

object

任意

タグ。

Key

string

任意

タグキー。

testKey

Value

string

任意

タグ値。

testValue

レスポンスフィールド

フィールド

説明

object

レスポンスのスキーマ。

RequestId

string

リクエスト ID。

8CD1852F-8176-55E4-891C-4478DC00CC7A

Items

object

PolarFsPaths

array<object>

PolarFS ファイルシステムのリスト。

array<object>

PolarFsPath

string

pfs-ins1*******

PolarFsStatus

string

Running

CreateTime

string

2021-09-13T15:45:35Z

ExpireTime

string

2026-03-16T16:00:00Z

PayType

string

Prepaid

RegionId

string

cn-beijing

ZoneId

string

cn-beijing-k

StorageSpace

integer

100

StorageType

string

city_redundancy

PolarFsInstanceId

string

pfs-2ze0i74ka607*****

PolarFsInstanceDescription

string

pfs-2ze0i74ka607*****

MountedAIDBClusters

object

MountedAIDBClusters

array<object>

object

DBClusterId

string

pc-uf6ts058spfqlczw1

MountedTime

string

17*********

MountDir

string

/mnt/pfs-xxx********

MountStatus

string

Mounting

Expired

string

False

Bandwidth

integer

200

PolarFsType

string

PolarFS 2.0

MountInfo

object

Token

string

***

PolarFsCluster

string

pfs-*******

PolarDbProxy

string

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

VPCId

string

vpc-uf653ibw32whvnplrnzz4

VSwitchId

string

vsw-uf6xz71d3a3mpmqtpljuz

SecurityGroupId

string

sg-8vbdy5mn2we1glzs31pm

RelativeDbClusterId

string

pc-bp18096c109yt52nz

Category

string

high_performance

AcceleratingEnable

string

ON

AcceleratedStorageSpace

string

10.0

Tags

object

Tag

array<object>

object

Key

string

testKey

Value

string

testValue

AccelerateType

string

juice

TotalRecordCount

integer

レコードの総数。

16

PageRecordCount

integer

現在のページのレコード数。

13

PageNumber

integer

ページ番号。

1

成功レスポンス

JSONJSON

{
  "RequestId": "8CD1852F-8176-55E4-891C-4478DC00CC7A",
  "Items": {
    "PolarFsPaths": [
      {
        "PolarFsPath": "pfs-ins1*******",
        "PolarFsStatus": "Running",
        "CreateTime": "2021-09-13T15:45:35Z",
        "ExpireTime": "2026-03-16T16:00:00Z",
        "PayType": "Prepaid",
        "RegionId": "cn-beijing",
        "ZoneId": "cn-beijing-k",
        "StorageSpace": 100,
        "StorageType": "city_redundancy",
        "PolarFsInstanceId": "pfs-2ze0i74ka607*****",
        "PolarFsInstanceDescription": "pfs-2ze0i74ka607*****",
        "MountedAIDBClusters": {
          "MountedAIDBClusters": [
            {
              "DBClusterId": "pc-uf6ts058spfqlczw1",
              "MountedTime": "17*********",
              "MountDir": "/mnt/pfs-xxx********",
              "MountStatus": "Mounting"
            }
          ]
        },
        "Expired": "False",
        "Bandwidth": 200,
        "PolarFsType": "PolarFS 2.0",
        "MountInfo": {
          "Token": "***",
          "PolarFsCluster": "pfs-*******",
          "PolarDbProxy": "TCP://**.**.**.**:3000,TCP://**.**.**.**:3000,TCP://**.**.**.**:3000"
        },
        "VPCId": "vpc-uf653ibw32whvnplrnzz4",
        "VSwitchId": "vsw-uf6xz71d3a3mpmqtpljuz",
        "SecurityGroupId": "sg-8vbdy5mn2we1glzs31pm",
        "RelativeDbClusterId": "pc-bp18096c109yt52nz",
        "Category": "high_performance",
        "AcceleratingEnable": "ON",
        "AcceleratedStorageSpace": "10.0",
        "Tags": {
          "Tag": [
            {
              "Key": "testKey",
              "Value": "testValue"
            }
          ]
        },
        "AccelerateType": "juice"
      }
    ]
  },
  "TotalRecordCount": 16,
  "PageRecordCount": 13,
  "PageNumber": 1
}

エラーコード

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

変更履歴

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