Referência de API do serviço Amazon GameLift (SDK da AWS) - Amazon GameLift

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Referência de API do serviço Amazon GameLift (SDK da AWS)

Este tópico fornece uma lista baseada em tarefas de operações de API para uso com as soluções de hospedagem gerenciada do Amazon GameLift, incluindo hospedagem para servidores de jogos personalizados e servidores em tempo real. Essas operações são empacotadas no SDK da AWS no namespace. aws.gamelift. Baixe o SDK da AWS ou veja a documentação de referência da API do Amazon GameLift.

A API inclui dois conjuntos de operações para hospedagem gerenciada de jogos:

A API do serviço Amazon GameLift também contém operações para uso com outras ferramentas e soluções do Amazon GameLift. Para obter uma lista das APIs do FleetIQ, consulte Ações da API do FleetIQ. Para obter uma lista de APIs do FlexMatch para criação de jogos, consulte Ações da API do FlexMatch.

Configurar e gerenciar os recursos de hospedagem do Amazon GameLift

Chame essas operações para configurar recursos de hospedagem para seus servidores de jogos, escalar a capacidade para atender à demanda dos jogadores, acessar métricas de desempenho e utilização e muito mais. Essas operações de API são usadas com servidores de jogos hospedados no Amazon GameLift, incluindo servidores em tempo real. É possível usar o console do Amazon GameLift para a maioria das tarefas de gerenciamento de recursos ou fazer chamadas para o serviço usando a ferramenta AWS Command Line Interface (AWS CLI) ou o SDK da AWS.

Preparare servidores de jogos para implantação

Carregue e configure o código do servidor de jogos do jogo em preparação para implantação e lançamento em recursos de hospedagem.

Gerenciar compilações do servidor de jogos personalizado

  • upload-build: carregue arquivos de compilação em um caminho local e crie um novo recurso de compilação do Amazon GameLift. Essa operação, disponível apenas como um comando da AWS CLI, é o método mais comum para carregar compilações de servidores de jogos.

  • CreateBuild: crie uma nova compilação usando os arquivos armazenados em um bucket do Amazon S3.

  • ListBuilds: obtenha uma lista de todas as compilações carregadas em uma região do Amazon GameLift.

  • DescribeBuild: recupere as informações associadas a uma compilação.

  • UpdateBuild: altere metadados da compilação, incluindo o nome e a versão da compilação.

  • DeleteBuild: Remova uma compilação do Amazon GameLift.

Gerenciar scripts de configuração de servidores em tempo real

  • CreateScript: carregue arquivos JavaScript e crie um novo recurso de script do Amazon GameLift.

  • ListScripts: obtenha uma lista de todos os scripts em tempo real carregados em uma região do Amazon GameLift.

  • DescribeScript: recupere as informações associadas a um script em tempo real.

  • UpdateScript: altere metadados do script e carregue o conteúdo revisado do script.

  • DeleteScript: remova um script em tempo real do Amazon GameLift.

Configurar recursos de computação para hospedagem

Configure recursos de hospedagem e implante-os com a compilação do servidor de jogos ou o script de configuração do em tempo real.

Criar e gerenciar frotas

  • CreateFleet: configure e implante uma nova frota de recursos de computação do Amazon GameLift para execução dos servidores de jogos. Depois de implantados, os servidores de jogos são automaticamente lançados conforme configurados e prontos para hospedar sessões de jogo.

  • ListFleets: obtenha uma lista de todas as frotas em uma região do Amazon GameLift.

  • DeleteFleet: encerre uma frota que não esteja mais executando servidores de jogos ou hospedando jogadores.

  • Visualize/atualize as localizações da frota.

  • Visualize/atualize as configurações de frota.

Gerenciar capacidade da frota

  • DescribeEC2InstanceLimits: recupere o número máximo de instâncias permitidas para a conta atual da AWS e o nível atual de uso.

  • DescribeFleetCapacity: recupere a configuração atual da capacidade da frota.

  • DescribeFleetLocationCapacity: recupere as configurações de capacidade atuais para cada local de uma frota com vários locais.

  • UpdateFleetCapacity: ajuste manualmente a configuração de capacidade da frota.

  • Configure o ajuste de escala automático:

    • PutScalingPolicy: ative o ajuste de escala automático baseado no destino, crie uma política de ajuste de escala automático personalizado ou atualize uma política existente.

    • DescribeScalingPolicies: recupere uma política de ajuste de escala automático existente.

    • DeleteScalingPolicy: exclua uma política de ajuste de escala automático e impeça que ela afete a capacidade de uma frota.

    • StartFleetActions: reinicie as políticas de ajuste de escala automático de uma frota.

    • StopFleetActions: suspenda as políticas de ajuste de escala automático de uma frota.

Monitore a atividade da frota.

  • DescribeFleetUtilization: recupere as estatísticas do número de processos do servidor, sessões de jogos e jogadores que estiverem ativos no momento em uma frota.

  • DescribeFleetLocationUtilization: recupere estatísticas de utilização para cada local em uma frota com vários locais.

  • DescribeFleetEvents: visualize os eventos registrados para uma frota durante um período especificado.

  • DescribeGameSessions: recupere os metadados da sessão de jogo, incluindo o tempo de execução de um jogo e a contagem atual de jogadores.

Configurar filas para o posicionamento ideal de sessão de jogo

Configure as filas de várias frotas e várias regiões para posicionar sessões de jogo com os melhores recursos de hospedagem disponíveis para custo, latência e resiliência.

Gerenciar aliases

Use aliases para representar suas frotas ou crie um destino alternativo de terminal. Os aliases são úteis ao fazer a transição da atividade do jogo de uma frota para outra, como durante as atualizações de compilação do servidor de jogos.

  • CreateAlias: defina um novo alias e, opcionalmente, atribua-o a uma frota.

  • ListAliases: obtenha todos os aliases de frota definidos em uma região do Amazon GameLift.

  • DescribeAlias: recupere as informações de um alias existente.

  • UpdateAlias: altere as configurações de um alias, como o encaminhamento dele de uma frota para outra.

  • DeleteAlias: remova um alias da região.

  • ResolveAlias: obtenha o ID da frota para o qual um alias especificado está apontando.

Acessar instâncias de hospedagem

Visualize informações sobre instâncias individuais em uma frota ou solicite acesso remoto a uma instância de frota especificada para solução de problemas.

  • DescribeInstances: obtenha as informações de cada instância em uma frota, incluindo o ID, o endereço IP, o local e o status dela.

  • GetInstanceAccess: solicite as credenciais de acesso necessárias para se conectar remotamente a uma instância especificada em uma frota.

Configurar o emparelhamento da VPC

Crie e gerencie conexões de emparelhamento da VPC entre os recursos de hospedagem do Amazon GameLift e outros recursos da AWS.

Inicie sessões de jogo e junte-se aos jogadores

Chame essas operações do serviço de cliente do jogo para iniciar novas sessões de jogo, obter informações sobre sessões de jogo existentes e adicionar jogadores às sessões de jogo. Essas operações são destinadas para uso com servidores de jogos personalizados hospedados no Amazon GameLift. Se estiver usando servidores em tempo real, gerencie as sessões de jogo usando o Referência de API (C#) do cliente dos servidores em tempo real.

  • Inicie novas sessões de jogo para um ou mais jogadores.

    • StartGameSessionPlacement: peça ao Amazon GameLift para encontrar os melhores recursos de hospedagem disponíveis e iniciar uma nova sessão de jogo. Esse é o método preferido para criar novas sessões de jogo. Ele se baseia em filas de sessões de jogo para rastrear a disponibilidade de hospedagem em várias regiões e usa algoritmos FleetiQ para priorizar posicionamentos com base na latência do jogador, custo de hospedagem, localização etc.

    • DescribeGameSessionPlacement: obtenha detalhes e status sobre uma solicitação de posicionamento.

    • StopGameSessionPlacement: cancele uma solicitação de posicionamento.

    • CreateGameSession: inicie uma nova sessão de jogo em uma frota específica. Essa operação oferece maior controle sobre onde iniciar a sessão do jogo, em vez de usar o FleetiQ para avaliar as opções de posicionamento. Você deve adicionar jogadores à nova sessão de jogo em uma etapa separada.

  • Coloque jogadores em sessões de jogo existentes. Encontre sessões de jogo em execução com slots de jogadores disponíveis e reserve-os para novos jogadores.

    • CreatePlayerSession: reserve um slot aberto para um jogador ingressar em uma sessão de jogo.

    • CreatePlayerSessions: reserve slots abertos para vários jogadores ingressarem em uma sessão de jogo.

  • Trabalhe com os dados da sessão de jogo e da sessão de jogadores. Gerencie informações sobre sessões de jogo e sessões de jogadores.

    • SearchGameSessions: solicite uma lista de sessões de jogo ativas com base em um conjunto de critérios de pesquisa.

    • DescribeGameSessions: recupere os metadados de uma ou mais sessões de jogos, incluindo o tempo de atividade e a contagem atual de jogadores.

    • DescribeGameSessionDetails: recupere os metadados, incluindo e a configuração de proteção da sessão de jogo de uma ou mais sessões de jogo.

    • DescribePlayerSessions: obtenha detalhes sobre a atividade do jogador, incluindo status, tempo de jogo e dados do jogador.

    • UpdateGameSession: altere as configurações da sessão de jogo, como a contagem máxima de jogadores e a política de participação.

    • GetGameSessionLogUrl: obtenha o local dos logs salvos de uma sessão de jogo.