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

Consulta uma lista de namespaces.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer para maior conveniência. A ferramenta também gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Cabeçalhos da requisição

Esta operação não possui cabeçalhos específicos e utiliza apenas os cabeçalhos comuns de requisição. Para mais informações, consulte Cabeçalhos comuns de requisição e resposta.

Sintaxe da requisição

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

Parâmetros da requisição

Parameter

Type

Position

Required

Example

Description

ContainCustom

Boolean

Query

true

Define se os namespaces personalizados devem ser retornados. Valores válidos:

true: Retorna namespaces personalizados.
false: Não retorna namespaces personalizados.

HybridCloudExclude

Boolean

Query

true

Indica se os namespaces de nuvem híbrida devem ser excluídos do resultado. Valores válidos:

true: Exclui os namespaces de nuvem híbrida do resultado.

Parâmetros de resposta

Parameter	Type	Example	Description
RequestId	String	30375C38-F4ED-4135-A0AE-5C75DC7F****	ID da requisição.
Message	String	success	Mensagem retornada. Valores válidos: success: Retornado em caso de chamada bem-sucedida. Código de erro: Retornado em caso de falha na chamada.
TraceId	String	ac1a0b2215622920113732501e****	ID de rastreamento usado para consultar detalhes da requisição.
Data	Array of RegionList		Namespaces consultados.
VpcId	String	vpc-2ze0i263cnn311nvj****	ID da VPC.
VSwitchId	String	vsw-2ze559r1z1bpwqxwp****	ID do vSwitch.
Custom	Boolean	true	Indica se namespaces personalizados foram retornados. Valores válidos: true: Namespaces personalizados retornados. false: Namespaces personalizados não retornados.
AgentInstall	String	http://edas-bj.oss-cn-beijing-internal.aliyuncs.com/test/install.sh	Comando executado para instale o agente.
NamespaceId	String	cn-beijing:test	ID do namespace.
HybridCloudEnable	Boolean	false	Define se os namespaces de nuvem híbrida estão excluídos. Valores válidos: true: Namespaces de nuvem híbrida excluídos. false: Namespaces de nuvem híbrida incluídos.
SecurityGroupId	String	sg-wz969ngg2e49q5i4****	ID do grupo de segurança.
Current	Boolean	false	Parâmetro obsoleto.
NamespaceName	String	test	Nome do namespace.
RegionId	String	cn-beijing	Região à qual o namespace pertence.
NameSpaceShortId	String	test	ID curto do namespace.
ErrorCode	String	Empty	Código de erro. Valores válidos: Chamada bem-sucedida: o parâmetro ErrorCode não é retornado. Falha na chamada: o parâmetro ErrorCode é retornado. Para mais informações, consulte a seção "Códigos de erro" neste tópico.
Code	String	200	Código de status HTTP. Valores válidos: 2xx: Chamada bem-sucedida. 3xx: Chamada redirecionada. 4xx: Falha na chamada. 5xx: Erro no servidor.
Success	Boolean	true	Indica se a consulta à lista de namespaces foi bem-sucedida. Valores válidos: true: Lista consultada com sucesso. false: Falha ao consultar a lista.

Exemplos

Exemplos de requisições

GET /pop/v1/sam/namespace/describeNamespaceList?ContainCustom=true&HybridCloudExclude=true HTTP/1.1
Host:sae.aliyuncs.com
Content-Type:application/json

Exemplos de respostas de sucesso

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

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

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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"
  } ],
  "Code" : "200",
  "Success" : true
}

Códigos de erro

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.