DescribePolarFs

Queries PolarFS information.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-beijing
PageSize	integer	No	The number of entries per page. Valid values: 30 50 100	30
PageNumber	integer	No	The page number. The value must be an integer greater than 0 and not exceeding the maximum value of Integer.	1
PolarFsInstanceIds	string	No	The list of PolarFS instance IDs, separated by commas (,).	pfs-ins1*******
PolarFsInstanceDescription	string	No	The description of the PolarFS instance.	pfs-ins1********
RelativeDbClusterId	string	No	The ID of the associated PolarDB cluster.	pc-2zejpr41d9xk*****
PolarFsType	string	No	The PolarFS type.	all
DBClusterId	string	No	The instance ID of the PolarDB instance on which the application depends.	pc-2ze8u21s03******
Tag	array<object>	No	The tags.
	object	No	The tags.
Key	string	No	The tag key.	testKey
Value	string	No	The tag value.	testValue

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	8CD1852F-8176-55E4-891C-4478DC00CC7A
Items	object
PolarFsPaths	array<object>	The list of PolarFS file systems.
	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	The total number of records.	16
PageRecordCount	integer	The number of records on the current page.	13
PageNumber	integer	The page number.	1

Examples

Success response

JSON format

{
  "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
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.