DescribePolarFs - PolarDB - Centro de documentación de Alibaba Cloud

Consulta la información de PolarFS.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

polardb:DescribePolarFs

get

*LakeCache

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

Ninguna

Sintaxis de la solicitud

POST  HTTP/1.1

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
RegionId	string	Sí	El ID de la región.	cn-beijing
PageSize	integer	No	El número de entradas por página. Valores válidos: 30 50 100	30
PageNumber	integer	No	El número de página. El valor debe ser un número entero mayor que 0 y que no exceda el valor máximo de Integer.	1
PolarFsInstanceIds	string	No	La lista de ID de instancias de PolarFS, separados por comas (,).	pfs-ins1*******
PolarFsInstanceDescription	string	No	La descripción de la instancia de PolarFS.	pfs-ins1********
RelativeDbClusterId	string	No	El ID del clúster de PolarDB asociado.	pc-2zejpr41d9xk*****
PolarFsType	string	No	El tipo de PolarFS.	all
DBClusterId	string	No	El ID de la instancia de PolarDB de la que depende la aplicación.	pc-2ze8u21s03******
Tag	array<object>	No	Las etiquetas.
	object	No	Las etiquetas.
Key	string	No	La clave de la etiqueta.	testKey
Value	string	No	El valor de la etiqueta.	testValue

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de respuesta.
RequestId	string	El ID de la solicitud.	8CD1852F-8176-55E4-891C-4478DC00CC7A
Items	object
PolarFsPaths	array<object>	La lista de sistemas de archivos PolarFS.
	array<object>
PolarFsPath	string	La ruta del sistema de archivos PolarFS.	pfs-ins1*******
PolarFsStatus	string	El estado de la instancia de PolarFS.	Running
CreateTime	string	La hora de creación.	2021-09-13T15:45:35Z
ExpireTime	string	La hora de vencimiento del clúster. Nota Este parámetro se devuelve solo para clústeres cuyo método de facturación es Prepaid (suscripción). Se devuelve un valor vacío para los clústeres Postpaid (pago por uso).	2026-03-16T16:00:00Z
PayType	string	El método de facturación. Valores válidos: Postpaid: pago por uso Prepaid: suscripción	Prepaid
RegionId	string	El ID de la región.	cn-beijing
ZoneId	string	El ID de la zona.	cn-beijing-k
StorageSpace	integer	El espacio de almacenamiento.	100
StorageType	string	El tipo de almacenamiento para la edición de alto rendimiento. Valores válidos: ESSDPL1 ESSDPL0 El tipo de almacenamiento para la edición básica. Valores válidos: city_redundancy: almacenamiento con redundancia de zona	city_redundancy
PolarFsInstanceId	string	El ID de la instancia de PolarFS.	pfs-2ze0i74ka607*****
PolarFsInstanceDescription	string	El nombre de la instancia de PolarFS.	pfs-2ze0i74ka607*****
MountedAIDBClusters	object
MountedAIDBClusters	array<object>	La lista de clústeres montados.
	object
DBClusterId	string	El ID del clúster.	pc-uf6ts058spfqlczw1
MountedTime	string	La hora en que se montó el sistema de archivos de la base de datos. El valor es una marca de tiempo en milisegundos.	17*********
MountDir	string	El directorio de montaje local.	/mnt/pfs-xxx********
MountStatus	string	El estado del montaje.	Mounting
Expired	string	Indica si el clúster ha vencido. Valores válidos: true false Nota Este parámetro se devuelve solo para clústeres cuyo método de facturación es Prepaid (suscripción).	False
Bandwidth	integer	El límite de ancho de banda del nodo. Unidad: MB/s.	200
PolarFsType	string	La versión de la instancia. Valores válidos: PolarFS 2.0: 2.0 PolarFS 1.0: 1.0	PolarFS 2.0
MountInfo	object	La configuración de montaje.
Token	string	Token.	***
PolarFsCluster	string	El nombre del sistema de archivos.	pfs-*******
PolarDbProxy	string	El endpoint de administración del clúster.	TCP://...:3000,TCP://...:3000,TCP://...:3000
VPCId	string	El ID de VPC.	vpc-uf653ibw32whvnplrnzz4
VSwitchId	string	El ID del vSwitch.	vsw-uf6xz71d3a3mpmqtpljuz
SecurityGroupId	string	El ID del security group administrado.	sg-8vbdy5mn2we1glzs31pm
RelativeDbClusterId	string	El ID del clúster de PolarDB asociado.	pc-bp18096c109yt52nz
Category	string	La edición de PolarFS. Valores válidos: high_performance: edición de alto rendimiento basic: edición básica cold: edición de almacenamiento en frío	high_performance
AcceleratingEnable	string	Indica si la caché de aceleración está habilitada. Valores válidos: ON: habilitada OFF: deshabilitada	ON
AcceleratedStorageSpace	string	El espacio de almacenamiento de aceleración. Unidad: GB.	10.0
Tags	object
Tag	array<object>	La lista de etiquetas.
	object	Las etiquetas.
Key	string	La clave de la etiqueta.	testKey
Value	string	El valor de etiqueta correspondiente a la clave de etiqueta. Nota El valor puede contener hasta 64 caracteres y no puede comenzar con `aliyun`, `acs:`, `http://` o `https://`.	testValue
AccelerateType	string	El tipo de aceleración.	juice
TotalRecordCount	integer	El número total de registros.	16
PageRecordCount	integer	El número de registros en la página actual.	13
PageNumber	integer	El número de página.	1

Ejemplos

Respuesta exitosa

JSON Formato

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

Códigos de error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.