DescribeNamespaces - 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:DescribeNamespaces

get

*All Resource

*

Nenhuma

Sintaxe da solicitação

GET /pop/v1/paas/namespaces HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
CurrentPage	integer	Sim	O número da página atual.	1
PageSize	integer	Sim	O número de entradas por página. Valores válidos: 0 a 10000.	10

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os dados retornados.
RequestId	string	O ID da solicitação.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	A mensagem retornada pelo sistema. Retorna sucesso se a solicitação for bem-sucedida. Retorna uma mensagem de erro específica se a solicitação falhar.	success
TraceId	string	O ID de rastreamento que pode ser usado para consultar os detalhes de uma chamada.	0a981dd515966966104121683d****
Data	object	Os detalhes dos namespaces.
CurrentPage	integer	O número da página atual.	1
TotalSize	integer	O número total de namespaces.	100
PageSize	integer	O número de entradas retornadas em cada página.	10
Namespaces	array<object>	A lista de namespaces.
	object	Os detalhes de um namespace.
NamespaceDescription	string	The description of the namespace.	desc
AccessKey	string	The access key ID for Application Configuration Management (ACM), used to manage data in an ACM namespace. For more information, see Differences between an Alibaba Cloud access key and an ACM-specific access key.	b34dbe3315c64f9f99b58ea447ec****
SecretKey	string	The secret access key for Application Configuration Management (ACM), used to manage data in an ACM namespace. For more information, see Differences between an Alibaba Cloud access key and an ACM-specific access key.	G/w6sseK7+nb3S6HBmANDBMD****
NamespaceId	string	The namespace ID. The default namespace cannot be queried, modified, or deleted.	cn-beijing:test
AddressServerHost	string	The service endpoint.	addr-bj-internal.edas.aliyun.com
NamespaceName	string	The name of the namespace.	name
TenantId	string	The tenant ID.	838cad95-973f-48fe-830b-2a8546d7****
RegionId	string	The ID of the region. For example, 'cn-beijing' indicates China (Beijing).	cn-beijing
NameSpaceShortId	string	The short ID of the namespace.	test
ErrorCode	string	O código de erro. Este parâmetro é retornado apenas se a solicitação falhar. Para obter mais informações, consulte a seção Códigos de erro neste tópico.
Code	string	O código de status HTTP. 2xx: A solicitação foi bem-sucedida. 3xx: A solicitação foi redirecionada. 4xx: A solicitação era inválida. 5xx: Ocorreu um erro no lado do servidor.	200
Success	boolean	Indica se a solicitação foi bem-sucedida. true: A solicitação foi bem-sucedida. false: A solicitação falhou.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a981dd515966966104121683d****",
  "Data": {
    "CurrentPage": 1,
    "TotalSize": 100,
    "PageSize": 10,
    "Namespaces": [
      {
        "NamespaceDescription": "desc",
        "AccessKey": "b34dbe3315c64f9f99b58ea447ec****",
        "SecretKey": "G/w6sseK7+nb3S6HBmANDBMD****",
        "NamespaceId": "cn-beijing:test",
        "AddressServerHost": "addr-bj-internal.edas.aliyun.com",
        "NamespaceName": "name",
        "TenantId": "838cad95-973f-48fe-830b-2a8546d7****",
        "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.