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

Nota

Você pode enviar no máximo duas consultas por segundo (QPS).

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	StartInstance	A operação a ser executada. Defina o valor como StartInstance.
DeployModule	String	Sim	vpc	Modo de implantação da instância do Message Queue for Apache Kafka. Valores válidos: vpc: implanta a instância com acesso apenas por uma Virtual Private Cloud (VPC). eip: implanta a instância com acesso pela Internet e por uma VPC. O modo de implantação deve corresponder ao tipo da instância. Defina o valor como vpc se a instância permitir acesso apenas por uma VPC. Defina o valor como eip se a instância permitir acesso pela Internet e por uma VPC.
InstanceId	String	Sim	alikafka_post-cn-v0h1fgs2****	ID da instância do Message Queue for Apache Kafka.
RegionId	String	Sim	cn-shanghai	ID da região da instância do Message Queue for Apache Kafka.
VpcId	String	Sim	vpc-bp1r4eg3yrxmygv****	ID da VPC onde implantar a instância do Message Queue for Apache Kafka.
VSwitchId	String	Sim	vsw-bp1j3sg5979fstnpl****	ID do vSwitch onde implantar a instância do Message Queue for Apache Kafka.
ZoneId	String	Não	cn-shanghai-a	ID da zona onde implantar a instância do Message Queue for Apache Kafka. O ID da zona da instância deve ser igual ao do vSwitch. O valor deve estar no formato zoneX ou RegionID-X. Exemplos: zonea e cn-shanghai-a.
IsEipInner	Boolean	Não	false	Indica se a instância do Message Queue for Apache Kafka oferece suporte a Elastic IP Addresses (EIPs). Valores válidos: true: a instância permite acesso pela Internet e por uma VPC, além de oferecer suporte a EIPs. false: a instância permite acesso apenas por uma VPC e não oferece suporte a EIPs. Este parâmetro deve corresponder ao tipo da instância.
IsSetUserAndPassword	Boolean	Não	false	Indica se um novo nome de usuário e senha serão definidos para a instância do Message Queue for Apache Kafka. Valores válidos: true: indica que um novo nome de usuário e senha foram definidos para a instância. false: indica que nenhum novo nome de usuário ou senha foi definido para a instância. Este parâmetro se aplica apenas a instâncias que permitem acesso pela Internet e por uma VPC.
Username	String	Não	username	Nome de usuário da instância do Message Queue for Apache Kafka. Este parâmetro se aplica apenas a instâncias que permitem acesso pela Internet e por uma VPC.
Password	String	Não	password	Senha da instância do Message Queue for Apache Kafka. Este parâmetro se aplica apenas a instâncias que permitem acesso pela Internet e por uma VPC.
Name	String	Não	newInstanceName	Nome da instância do Message Queue for Apache Kafka. Nota Certifique-se de que o valor do parâmetro seja exclusivo na região da instância.
SecurityGroup	String	Não	sg-bp13wfx7kz9pkow***	Grupo de segurança da instância do Message Queue for Apache Kafka. Se você não especificar este parâmetro, o Message Queue for Apache Kafka configurará automaticamente um grupo de segurança para a instância. Caso especifique este parâmetro, crie o grupo de segurança indicado antecipadamente. Para mais informações, consulte Criar um grupo de segurança.
ServiceVersion	String	Não	0.10.2	Versão da instância do Message Queue for Apache Kafka. Valores válidos: 0.10.2 e 2.2.0.
Config	String	Não	null	Configurações iniciais da instância do Message Queue for Apache Kafka. O valor deve ser uma string JSON válida. Se você não especificar este parâmetro, ele permanecerá vazio. O parâmetro Config aceita os seguintes parâmetros: enable.vpc_sasl_ssl: indica se a criptografia de transmissão da VPC está ativada. Valores válidos: true: a criptografia de transmissão da VPC está ativada. Se você ativar a criptografia de transmissão da VPC, ative também a Access Control List (ACL). false: a criptografia de transmissão da VPC está desativada. Por padrão, a criptografia de transmissão da VPC fica desativada. enable.acl: indica se a ACL está ativada. Valores válidos: true: a ACL está ativada. false: a ACL está desativada. Por padrão, a ACL fica desativada. kafka.log.retention.hours: período máximo de retenção de mensagens quando a capacidade do disco é suficiente. Unidade: horas. Valores válidos: 24 a 480. Valor padrão: 72. Quando o uso do disco atinge 85%, a capacidade é considerada insuficiente e o sistema exclui as mensagens na ordem em que foram armazenadas, da mais antiga para a mais recente. kafka.message.max.bytes: tamanho máximo das mensagens que o Message Queue for Apache Kafka pode enviar e receber. Unidade: byte. Valores válidos: 1048576 a 10485760. Valor padrão: 1048576. Antes de modificar o tamanho máximo da mensagem, certifique-se de que o novo valor seja consistente com os valores definidos no produtor e no consumidor.
KMSKeyId	String	Não	0d24xxxx-da7b-4786-b981-9a164dxxxxxx	ID da chave usada para criptografar dados em SSDs padrão na região da instância. Obtenha o ID da chave no console do Key Management Service (KMS) ou crie uma chave. Para mais informações, consulte Gerenciar CMKs. Se este parâmetro for especificado, a criptografia será ativada para a instância. Não é possível desativar a criptografia após a ativação. Ao chamar esta operação, o sistema verifica se a função vinculada ao serviço AliyunServiceRoleForAlikafkaInstanceEncryption foi criada. Caso contrário, o sistema a cria automaticamente. Para mais informações, consulte Funções vinculadas ao serviço.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
Code	Integer	200	Código de status HTTP. O código 200 indica que a solicitação foi bem-sucedida.
Message	String	operation success.	Mensagem retornada.
RequestId	String	ABA4A7FD-E10F-45C7-9774-A5236015A***	ID da solicitação.
Success	Boolean	true	Indica se a solicitação foi bem-sucedida.

Exemplos

Exemplos de solicitações

http(s)://[Endpoint]/?Action=StartInstance
&DeployModule=vpc
&InstanceId=alikafka_post-cn-v0h1fgs2****
&RegionId=cn-shanghai
&VpcId=vpc-bp1r4eg3yrxmygv****
&VSwitchId=vsw-bp1j3sg5979fstnpl****
&ZoneId=cn-shanghai-a
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

<StartInstanceResponse>
      <Message>operation success.</Message>
      <RequestId>ABA4A7FD-E10F-45C7-9774-A5236015A***</RequestId>
      <Success>true</Success>
      <Code>200</Code>
</StartInstanceResponse>

Formato JSON

{
    "RequestId":"ABA4A7FD-E10F-45C7-9774-A5236015A***",
    "Message":"operation success.",
    "Code":"200",
    "Success":"true"
}

Códigos de erro

Para obter uma lista de códigos de erro, visite a Central de Erros de API.