DescribePolarFsAttribute - PolarDB: Central de Documentação do Alibaba Cloud

Obtém os detalhes de uma instância PolarLakebase.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

polardb:DescribePolarFsAttribute

get

*LakeCache.

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

Nenhuma

Sintaxe da solicitação

GET  HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
PolarFsInstanceId	string	Sim	O ID da instância PolarLakebase.	pfs-2ze0i74ka607*****
QueryFuseMountInfo	boolean	Não	Especifica se as informações de montagem do Fuse devem ser consultadas. Valores válidos: true: Sim. false: Não. Este é o valor padrão.	false
DBClusterId	string	Não	O ID do cluster. Nota Você pode chamar a operação DescribeDBClusters para consultar os detalhes de todos os clusters em sua conta, incluindo os IDs dos clusters.	pc-bp1q76364ird*****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
RequestId	string	O ID da solicitação.	3F9E6A3B-C13E-4064-A010-18582A******
RelativeDbClusterId	string	O ID do cluster PolarDB associado.	pc-2zejpr41d9xk3uk34
PolarFsInstanceId	string	O ID da instância PolarLakebase.	pfs-2ze0i74ka607*****
PolarFsStatus	string	O status da instância PolarLakebase.	Running
PolarFsVersion	string	A versão.	1.0.1-1.0.3
PayType	string	O método de cobrança. Valores válidos: Postpaid: Pós-pago. Prepaid: Assinatura.	Prepaid
DBType	string	O tipo de ecossistema de banco de dados. Valores válidos: MySQL PostgreSQL	MySQL
PolarFsInstanceDescription	string	A descrição da instância PolarLakebase.	pfs-xxx
RegionId	string	O ID da região.	cn-beijing
ZoneId	string	O ID da zona do vSwitch.	cn-beijing-k
VPCId	string	O ID da VPC.	vpc-**********
VSwitchId	string	O ID do vSwitch.	vsw-**************
SecurityGroupId	string	O ID do grupo de segurança gerenciado.	sg-bp**************
CreateTime	string	A hora de criação.	2021-08-02T05:57:10Z
ExpireTime	string	A hora de expiração do cluster. Nota Este parâmetro é retornado apenas para clusters que usam o método de cobrança Prepaid (assinatura). Um valor vazio é retornado para clusters Postpaid (pós-pago).	2025-10-10T16:00:00Z
Expired	string	Indica se o cluster expirou. Nota Este parâmetro é retornado apenas para clusters que usam o método de cobrança Prepaid (assinatura).	false
PolarFsType	string	A versão da instância. Valores válidos: PolarFS 2.0: 2.0. PolarFS 1.0: 1.0.	PolarFS 2.0
StorageSpace	number	O espaço de armazenamento. Unidade: GB.	1000
StorageUsed	number	O espaço de armazenamento utilizado. Unidade: bytes.	3012558848
Bandwidth	number	A largura de banda. Unidade: MB/s.	100
BandwidthBaseLine	number	A linha de base de largura de banda. Unidade: MB/s/TiB.	100
Category	string	A edição do PolarLakebase. Valores válidos: high_performance: Edição de alto desempenho. basic: Edição básica. cold: Edição de armazenamento frio.	high_performance
LockMode	string	O modo de bloqueio. Valores válidos: Unlock: Não bloqueado. ManualLock: Bloqueado manualmente. LockByExpiration: Bloqueado automaticamente devido à expiração do cluster.	Unlock
StorageType	string	O tipo de armazenamento para a Edição de alto desempenho. Valores válidos: ESSDPL1 ESSDPL0 O tipo de armazenamento para a Edição básica. Valores válidos: city_redundancy: Armazenamento com redundância de zona.	essdpl1
AcceleratingEnable	string	Especifica se o cache de aceleração está ativado. Valores válidos: ON: Ativado. OFF: Desativado.	ON
AcceleratedStorageSpace	number	O espaço de armazenamento de aceleração. Unidade: GB.	1000
MountInfo	object	A configuração de montagem.
PolarFsCluster	string	O nome do sistema de arquivos.	pfs-**********
Token	string	O valor do token.	a734298c391cb9ebd05e2ee85feb624
PolarDbProxy	string	O endpoint de gerenciamento do cluster.	TCP://...:3000,TCP://...:3000,TCP://...:3000
MinorVersion	string	A versão secundária da instância.	v1.3.0-v1.1.1
ClientDownloadPath	string	A URL de download do cliente.	oss://*
MetaUrl	string	A URL de metadados criptografados para montagem do Fuse.	e6cc1d2e2a6fa292038d999fda6501*****
RelativePfsClusterId	string	O ID da instância PolarLakebase associada.	pfs-**********
BucketId	string	O ID do bucket.	xxx
FileSystemId	string	O ID do sistema de arquivos.	xxx
CustomBucketPath	string	O caminho personalizado do bucket.	xxxxxx-%d.oss-cn-beijing-internal.aliyuncs.com
AccelerateType	string	O tipo de aceleração.	alluxio
CustomBucketPathList	array<object>	A lista de caminhos de armazenamento personalizados.
	object	As informações de armazenamento personalizado.
Bucket	string	O bucket de armazenamento personalizado.	pfs-xxx.oss-[regionId]-internal.aliyuncs.com
Path	string	O caminho de armazenamento personalizado.	/data
MetaInstanceName	string		pc-xxxxxxxxxxxxxxxxx
DBEndpointId	string
MaxscaleEndpointId	string
MetaConnString	string
MetaMxsConnString	string
EndpointItems	array<object>
	array<object>
DBEndpointId	string		ep-xxxxxxxxx
EndpointType	string		S3Gateway
AddressItems	array<object>
	object
ConnectionString	string
IPAddress	string
Port	string
VPCId	string
VSwitchId	string
NetType	string
UserDefaultAccName	string		lakebase_acc
UserDefaultAccSk	string		EncryptedSecretKey==

Exemplos

Resposta de sucesso

JSON formato

{
  "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-[regionId]-internal.aliyuncs.com",
      "Path": "/data"
    }
  ],
  "MetaInstanceName": "pc-xxxxxxxxxxxxxxxxx",
  "DBEndpointId": "",
  "MaxscaleEndpointId": "",
  "MetaConnString": "",
  "MetaMxsConnString": "",
  "EndpointItems": [
    {
      "DBEndpointId": "ep-xxxxxxxxx",
      "EndpointType": "S3Gateway",
      "AddressItems": [
        {
          "ConnectionString": "",
          "IPAddress": "",
          "Port": "",
          "VPCId": "",
          "VSwitchId": "",
          "NetType": ""
        }
      ]
    }
  ],
  "UserDefaultAccName": "lakebase_acc",
  "UserDefaultAccSk": "EncryptedSecretKey=="
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.