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

Depuração

Chame esta operação no OpenAPI Explorer. Não é necessário calcular assinaturas. Após uma chamada bem-sucedida, o OpenAPI Explorer gera automaticamente exemplos de código SDK.

Cabeçalhos da requisição

Esta operação usa apenas cabeçalhos de requisição comuns. Para mais informações, consulte Parâmetros de requisição comuns.

Sintaxe da requisição

POST /pop/v5/k8s_clusters HTTP/1.1

Parâmetros da requisição

Nome	Tipo	Posição	Obrigatório	Exemplo	Descrição
RegionTag	String	Query	Sim	cn-hangzhou	Região.
CurrentPage	Integer	Query	Não	1	Número da página a retornar em uma consulta paginada. Valor padrão: 1.
PageSize	Integer	Query	Não	10	Quantidade de entradas a retornar por página em uma consulta paginada. Valor padrão: 1000.
ClusterType	Integer	Query	Não	5	Tipo do cluster.

Dados de retorno

Nome	Tipo	Exemplo	Descrição
Code	Integer	200	Código de status HTTP ou código de erro do ponto de presença (POP).
Message	String	success	Informações adicionais.
RequestId	String	C3CE915C-0C83-4AA5-8D66-E8BEED62939E	ID da requisição.
ClusterPage	Object		Lista paginada de clusters.
CurrentPage	Integer	1	Número da página retornada. Valor padrão: 1.
PageSize	Integer	10	Quantidade de entradas retornadas por página. Valor padrão: 1000.
TotalSize	Integer	5	Número total de páginas.
ClusterList	Array of Cluster		Lista de clusters.
Cluster
VpcId	String	vpc-z1mlwpbjx3e9m	ID da VPC.
VswitchId	String	vsw-bp1uf97**xjxgip**	ID do vSwitch.
SubNetCidr	String	172.20.0.0/16	Bloco CIDR da sub-rede.
Mem	Integer	2048	Tamanho total da memória. Unidade: MB.
RegionId	String	test	ID do namespace.
CsClusterStatus	String	running	Status de execução do cluster do Container Service. Valores válidos: initial: O cluster está sendo inicializado. failed: Falha na criação do cluster. running: O cluster está em execução. updating: O cluster está sendo atualizado. scaling: O cluster está em expansão. removing: Nós estão sendo removidos do cluster. upgrading: O cluster está sendo atualizado para nova versão. deleting: O cluster está sendo excluído. delete_failed: Falha ao excluir o cluster. deleted: O cluster foi excluído. Este status não fica visível para os usuários.
Cpu	Integer	4	Número total de núcleos de CPU.
NetworkMode	Integer	2	Tipo de rede do cluster. Valores válidos: 1: Rede clássica 2: VPC
CsClusterId	String	2ce62869f4d4466b920312315f05****	ID do cluster no ACK.
Description	String	test	Descrição do cluster.
ClusterType	Integer	5	Tipo do cluster. Valores válidos: 2: Cluster do Elastic Compute Service (ECS) 5: Cluster ACK ou ASK
ClusterStatus	Integer	1	Status de execução do cluster. Valores válidos: 1: Normal 2: Anormal 3: Offline
ClusterName	String	test	Nome do cluster.
NodeNum	Integer	4	Número de nós.
ClusterId	String	81453e4b-4df0-4592-**-b835a2ee**	ID do cluster.
ClusterImportStatus	Integer	1	Status de importação do cluster. Valores válidos: 0: Não importado 1: Importado 2: Falha na importação 3: Importando 4: Excluído

Exemplos

Exemplo de requisição

POST /pop/v5/k8s_clusters?RegionTag=cn-hangzhou&CurrentPage=1&PageSize=10&ClusterType=5 HTTP/1.1
Host:edas.aliyuncs.com
Content-Type:application/json

Exemplos de resposta

Formato XML

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

<RequestId>C3CE915C-0C83-4AA5-8D66-E8BEED62939E</RequestId>
<Message>success</Message>
<ClusterPage>
    <ClusterList>
        <Cluster>
            <ClusterImportStatus>1</ClusterImportStatus>
            <NodeNum>3</NodeNum>
            <ClusterId>6cd7d5d3-2c7b-48be-a874-3e746708****</ClusterId>
            <Cpu>0</Cpu>
            <ClusterType>5</ClusterType>
            <NetworkMode>2</NetworkMode>
            <CsClusterId>c0b7a530b96d24b46bd02da2316c****</CsClusterId>
            <VswitchId>vsw-bp1y77ga5pz9lianh****</VswitchId>
            <VpcId>vpc-bp1jmhiplgziujhw0****</VpcId>
            <Mem>0</Mem>
            <ClusterName>gray</ClusterName>
            <SubNetCidr>172.20.0.0/16</SubNetCidr>
            <RegionId>cn-hangzhou:test</RegionId>
            <CsClusterStatus>running</CsClusterStatus>
            <ClusterStatus>0</ClusterStatus>
        </Cluster>
    </ClusterList>
    <PageSize>17</PageSize>
    <CurrentPage>0</CurrentPage>
    <TotalSize>17</TotalSize>
</ClusterPage>
<Code>200</Code>

Formato JSON

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

{
  "RequestId" : "C3CE915C-0C83-4AA5-8D66-E8BEED62939E",
  "Message" : "success",
  "ClusterPage" : {
    "ClusterList" : {
      "Cluster" : [ {
        "ClusterImportStatus" : 1,
        "NodeNum" : 3,
        "ClusterId" : "6cd7d5d3-2c7b-48be-a874-3e746708****",
        "Cpu" : 0,
        "ClusterType" : 5,
        "NetworkMode" : 2,
        "CsClusterId" : "c0b7a530b96d24b46bd02da2316c****",
        "VswitchId" : "vsw-bp1y77ga5pz9lianh****",
        "VpcId" : "vpc-bp1jmhiplgziujhw0****",
        "Mem" : 0,
        "ClusterName" : "gray",
        "SubNetCidr" : "172.20.0.0/16",
        "RegionId" : "cn-hangzhou:test",
        "CsClusterStatus" : "running",
        "ClusterStatus" : 0
      } ]
    },
    "PageSize" : 17,
    "CurrentPage" : 0,
    "TotalSize" : 17
  },
  "Code" : 200
}

Códigos de erro

HttpCode	Código de erro	Mensagem de erro	Descrição
500	Edas.errorcode.PermissionDenied.message	You are not authorized to perform the operation.	Você não tem as permissões necessárias para executar esta operação.

Para obter uma lista de outros códigos de erro, consulte o Error Center.