Pré-verificação de recursos
Função
Essa API é usada para pré-verificar recursos. Antes de chamar essa API:
- Saiba como autorizá-la e autenticá-la.
- Obtenha a região e o ponto de extremidade necessários.
URI
POST /v3/{project_id}/resource-check
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
project_id |
Sim |
String |
ID do projeto de um locatário numa região. Para obter esse valor, consulte Obtenção de um ID de projeto. |
Parâmetros de solicitação
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
X-Auth-Token |
Sim |
String |
Token do usuário. Para obter o valor, chame a API para obtenção de um token de usuário. Depois que a solicitação é processada, o valor de X-Subject-Token no cabeçalho da mensagem é o valor do token. |
X-Language |
Não |
String |
Tipo de linguagem da solicitação. O valor padrão é en-us. Intervalo de valores:
|
Content-Type |
Sim |
String |
Tipo de conteúdo. Valor: application/json |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
action |
Sim |
String |
Tipo de verificação.
|
resource |
Sim |
CheckResourceInfo object |
Informação de recursos. |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
enterprise_project_id |
Não |
String |
ID do projeto empresarial. Esse parâmetro é obrigatório quando action é definido como createInstance. |
instance_num |
Não |
Integer |
Número de instâncias. Esse parâmetro é obrigatório quando action é definido como createInstance. |
mode |
Não |
String |
Tipos de instância. Seu valor é Cluster. Esse parâmetro é obrigatório quando action é definido como createInstance. |
availability_zone_mode |
Não |
String |
Tipo de AZ. O valor pode ser single ou multi. Esse parâmetro é obrigatório quando action é definido como createInstance. |
node_num |
Não |
Integer |
Número de nós. Esse parâmetro é obrigatório quando action é definido como createInstance ou createReadonlyNode. |
flavor_ref |
Não |
String |
Código de especificação. Este parâmetro é obrigatório quando action é definido como createInstance ou resizeFlavor. |
availability_zone |
Não |
String |
Código de AZ. |
subnet_id |
Não |
String |
ID da sub-rede. Esse parâmetro é obrigatório quando action é definido como createInstance. |
instance_id |
Não |
String |
ID da instância. Este parâmetro é obrigatório quando action é definido como createReadonlyNode ou resizeFlavor. |
Parâmetros de resposta
Código de status: 200
Parâmetro |
Tipo |
Descrição |
---|---|---|
result |
Boolean |
Resultado retornado.
|
Código de status: 400
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_code |
String |
Código de erro. |
error_msg |
String |
Mensagem de erro. |
Código de status: 500
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_code |
String |
Código de erro. |
error_msg |
String |
Mensagem de erro. |
Exemplo de solicitação
- Pré-verificação de recursos durante a criação da instância
POST https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/resource-check { "action" : "createInstance", "resource" : { "enterprise_project_id" : 0, "instance_num" : 1, "mode" : "Cluster", "availability_zone_mode" : "single", "node_num" : 2, "flavor_ref" : "gaussdb.mysql.xlarge.x86.4", "availability_zone" : "cn-southwest-244b", "subnet_id" : "1e9f71dd-9192-4c0d-9739-161d8dcca68c" } }
- Pré-verificação de recursos durante a criação da réplica de leitura
POST https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/resource-check { "action" : "createReadonlyNode", "resource" : { "instance_id" : "376e0847a2224e95afcd3e607eccd544in07", "node_num" : 1 } }
- Pré-verificação de recursos durante a alteração da especificação da instância
POST https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/resource-check { "action" : "resizeFlavor", "resource" : { "instance_id" : "376e0847a2224e95afcd3e607eccd544in07", "flavor_ref" : "gaussdb.mysql.xlarge.x86.4" } }
Exemplo de resposta
Código de status: 200
Bem-sucedido.
{ "result" : true }
Código de status
Código de status |
Descrição |
---|---|
200 |
Bem-sucedido. |
400 |
Erro do cliente. |
500 |
Erro no servidor. |
Código de erro
Para obter detalhes, consulte Códigos de erro.