Todos os produtos
Search

Este produto

    Cloud Parallel File Storage:DescribeProtocolService

    Central de documentação

    Cloud Parallel File Storage:DescribeProtocolService

    Última atualização: Oct 26, 2026

    Consulta as informações do serviço de protocolo.

    Descrição da operação

    Esta operação é aplicável apenas a sistemas de arquivos CPFS.

    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

    nas:DescribeProtocolService

    list

    *FileSystem.

    acs:nas:{#regionId}:{#accountId}:filesystem/{#FileSystemId}

    		 Nenhuma Nenhuma

    Parâmetros da solicitação

    Parâmetro

    Tipo

    Obrigatório

    Descrição

    Exemplo
    ProtocolServiceIds

    string

    Não

    Os IDs dos serviços de protocolo.

    • Formato: CSV

    • Limite: Podem ser especificados até 10 IDs de serviços de protocolo.

    ptc-197ed6a00f2b****,ptc-196ed6a00f2b****
    Status

    string

    Não

    Filtra os serviços de protocolo por status.

    Formato: CSV

    Valores válidos:

    • Creating: O serviço de protocolo está sendo criado.

    • Starting: O serviço de protocolo está sendo iniciado.

    • Running: O serviço de protocolo está disponível.

    • Updating: O serviço de protocolo está sendo atualizado.

    • Deleting: O serviço de protocolo está sendo excluído.

    • Stopping: O serviço de protocolo está sendo interrompido.

    • Stopped: O serviço de protocolo está interrompido.

    Running,Updating
    NextToken

    string

    Não

    O token de paginação. Se a resposta for truncada, você pode usar este token para iniciar outra solicitação e recuperar os resultados restantes.

    aBcdg==
    MaxResults

    integer

    Não

    O número máximo de entradas a serem retornadas para uma única solicitação.

    • Valor máximo: 100.

    • Valor mínimo: 10.

    • Valor padrão: 20.

    20
    FileSystemId

    string

    Sim

    O ID do sistema de arquivos.

    cpfs-099394bd928c****
    Description

    string

    Não

    Filtra os serviços de protocolo por descrição ou parte da descrição.

    Limites:

    • A descrição deve ter de 2 a 128 caracteres de comprimento.

    • A descrição deve começar com uma letra e não pode começar com http:// ou https://.

    • A descrição pode conter dígitos, dois-pontos (:), sublinhados (_) e hifens (-).

    The description of this protocol service
    ClientToken

    string

    Não

    O token do cliente que é usado para garantir a idempotência da solicitação. Você pode usar o cliente para gerar o token, mas deve garantir que o token seja exclusivo entre diferentes solicitações. O token pode conter apenas caracteres ASCII e não pode exceder 64 caracteres de comprimento. Para mais informações, consulte Como garantir a idempotência.

    Nota

    Se você não especificar este parâmetro, o sistema usará automaticamente o RequestId da solicitação de API como ClientToken. O RequestId de cada solicitação de API pode ser diferente.

    473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

    Elementos de resposta

    Elemento

    Tipo

    Descrição

    Exemplo

    object

    Esquema da resposta.

    RequestId

    string

    O ID da solicitação.

    473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
    NextToken

    string

    O token de paginação que é usado para consultar os serviços de protocolo restantes.

    aBcdeg==
    ProtocolServices

    array<object>

    A lista de serviços de protocolo.

    object

    As informações do serviço de protocolo.

    FileSystemId

    string

    O ID do sistema de arquivos.

    cpfs-099394bd928c****
    ProtocolServiceId

    string

    O ID do serviço de protocolo.

    ptc-197ed6a00f2b****
    ProtocolSpec

    string

    As especificações do cluster de protocolo.

    • Valores válidos: General.

    • Valor padrão: General.

    General
    ProtocolThroughput

    integer

    A taxa de transferência do serviço de protocolo. Unidade: MB/s.

    500
    InstanceRAM

    integer

    O tamanho do cache de memória do nó de protocolo. Unidade: GiB.

    0
    InstanceBaseThroughput

    integer

    A taxa de transferência base do nó de protocolo. Unidade: MB/s.

    100
    InstanceBurstThroughput

    integer

    A taxa de transferência de pico do nó de protocolo. Unidade: MB/s.

    100
    MountTargetCount

    integer

    O número total de diretórios e filesets CPFS exportados no serviço de protocolo.

    5
    ProtocolType

    string

    O tipo de protocolo suportado pelo serviço de protocolo.

    Valores válidos:

    • NFS: O serviço de protocolo suporta acesso pelo protocolo NFS.

    NFS
    Status

    string

    O status do serviço de protocolo.

    Valores válidos:

    • Creating: O serviço de protocolo está sendo criado.

    • Starting: O serviço de protocolo está sendo iniciado.

    • Running: O serviço de protocolo está disponível.

    • Updating: O serviço de protocolo está sendo atualizado.

    • Deleting: O serviço de protocolo está sendo excluído.

    • Stopping: O serviço de protocolo está sendo interrompido.

    • Stopped: O serviço de protocolo está interrompido.

    Running
    Description

    string

    A descrição do serviço de protocolo.

    Limites:

    • A descrição deve ter de 2 a 128 caracteres de comprimento.

    • A descrição deve começar com uma letra e não pode começar com http:// ou https://.

    • A descrição pode conter dígitos, dois-pontos (:), sublinhados (_) e hifens (-).

    The description of this protocol service
    CreateTime

    string

    A hora em que o serviço de protocolo foi criado. A hora é exibida em UTC.

    2018-12-12T07:28:38Z
    ModifyTime

    string

    A hora em que o serviço de protocolo foi modificado. A hora é exibida em UTC.

    2018-12-12T07:28:38Z
    VpcId

    string

    O ID da VPC associada ao serviço de protocolo.

    vpc-123xxx
    VSwitchId

    string

    O ID do vSwitch associado ao serviço de protocolo.

    vsw-123xxx

    Exemplos

    Resposta de sucesso

    JSON formato

    {
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "NextToken": "aBcdeg==",
  "ProtocolServices": [
    {
      "FileSystemId": "cpfs-099394bd928c****",
      "ProtocolServiceId": "ptc-197ed6a00f2b****",
      "ProtocolSpec": "General",
      "ProtocolThroughput": 500,
      "InstanceRAM": 0,
      "InstanceBaseThroughput": 100,
      "InstanceBurstThroughput": 100,
      "MountTargetCount": 5,
      "ProtocolType": "NFS",
      "Status": "Running",
      "Description": "The description of this protocol service",
      "CreateTime": "2018-12-12T07:28:38Z",
      "ModifyTime": "2018-12-12T07:28:38Z",
      "VpcId": "vpc-123xxx",
      "VSwitchId": "vsw-123xxx"
    }
  ]
}

    Códigos de erro

    Código de status HTTP

    Código de erro

    Mensagem de erro

    Descrição
    400 MissingFileSystemId FileSystemId is mandatory for this action. O parâmetro FileSystemId não foi especificado.
    400 InvalidParam.TooManyProtocolServiceIds Too many protocol service ids given. O número de IDs de serviço de protocolo especificados em uma única consulta excede o limite.
    403 InvalidStatus.NotSupported The specified protocol service status does not support. O status do cluster de servidores de protocolo especificado não é suportado.
    404 InvalidFileSystem.NotFound The specified file system does not exist. O sistema de arquivos especificado não existe.
    404 InvalidParameter.InvalidNextToken The specified NextToken is invaild.
    404 InvalidParameter.InvalidMaxResults The specified MaxResults is invalid. O parâmetro MaxResults especificado é inválido.

    Consulte Códigos de Erro para uma lista completa.

    Notas de versão

    Consulte Notas de Versão para uma lista completa.