DescribeNamespaceList - Serverless App Engine: Central de Documentação do Alibaba Cloud

Consulta uma lista de namespaces.

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

sae:DescribeNamespaceList

get

*All Resource

*

Nenhuma

Sintaxe da solicitação

GET /pop/v1/sam/namespace/describeNamespaceList HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ContainCustom	boolean	Não	Especifica se namespaces personalizados devem ser retornados. Valores válidos: true: O sistema retorna namespaces personalizados. false: O sistema não retorna namespaces personalizados.	true
HybridCloudExclude	boolean	Não	Indica se namespaces de nuvem híbrida são excluídos. Valores válidos: true: Namespaces de nuvem híbrida são excluídos. false: Namespaces de nuvem híbrida são incluídos.	true

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os dados retornados.
RequestId	string	O ID da solicitação.	30375C38-F4ED-4135-A0AE-5C75DC7F****
Message	string	A mensagem retornada. Valores válidos: success: Se a chamada for bem-sucedida, success é retornado. Um código de erro: Se a chamada falhar, um código de erro é retornado.	success
TraceId	string	O ID de rastreamento usado para consultar os detalhes da solicitação.	ac1a0b2215622920113732501e****
Data	array<object>	A lista de namespaces.
	object	As informações sobre namespaces.
VpcId	string	O ID da virtual private cloud (VPC).	vpc-2ze0i263cnn311nvj****
VSwitchId	string	O ID do vSwitch.	vsw-2ze559r1z1bpwqxwp****
Custom	boolean	Indica se namespaces personalizados são retornados. Valores válidos: true: Namespaces personalizados são retornados. false: Namespaces personalizados não são retornados.	true
AgentInstall	string	O comando executado para instalar o agente.	http://edas-bj.oss-cn-beijing-internal.aliyuncs.com/test/install.sh
NamespaceId	string	O ID do namespace.	cn-beijing:test
HybridCloudEnable	boolean	Indica se namespaces de nuvem híbrida são excluídos. Valores válidos: true: Namespaces de nuvem híbrida são excluídos. false: Namespaces de nuvem híbrida são incluídos.	false
SecurityGroupId	string	O ID do grupo de segurança.	sg-wz969ngg2e49q5i4****
Current	boolean	Este parâmetro não é mais válido.	false
NamespaceName	string	O nome do namespace.	test
RegionId	string	A região à qual o namespace pertence.	cn-beijing
NameSpaceShortId	string	O ID curto do namespace.	test
ErrorCode	string	O código de erro. Valores válidos: Se a chamada for bem-sucedida, o parâmetro ErrorCode não é retornado. Se a chamada falhar, o parâmetro ErrorCode é retornado. Para mais informações, consulte a seção Códigos de erro neste tópico.
Code	string	O código de status HTTP. Valores válidos: 2xx: A chamada foi bem-sucedida. 3xx: A chamada foi redirecionada. 4xx: A chamada falhou. 5xx: Ocorreu um erro no servidor.	200
Success	boolean	Indica se a lista de namespaces foi consultada. Valores válidos: true: A lista foi consultada. false: A consulta da lista falhou.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "30375C38-F4ED-4135-A0AE-5C75DC7F****",
  "Message": "success",
  "TraceId": "ac1a0b2215622920113732501e****",
  "Data": [
    {
      "VpcId": "vpc-2ze0i263cnn311nvj****",
      "VSwitchId": "vsw-2ze559r1z1bpwqxwp****",
      "Custom": true,
      "AgentInstall": "http://edas-bj.oss-cn-beijing-internal.aliyuncs.com/test/install.sh",
      "NamespaceId": "cn-beijing:test",
      "HybridCloudEnable": false,
      "SecurityGroupId": "sg-wz969ngg2e49q5i4****",
      "Current": false,
      "NamespaceName": "test",
      "RegionId": "cn-beijing",
      "NameSpaceShortId": "test"
    }
  ],
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

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.