Chame a operação UpdatePublicNetwork para ativar ou desativar o endereço de rede pública da instância do Elasticsearch especificada.
Ao chamar esta operação, observe os seguintes pontos:
Não é possível atualizar a configuração quando a instância está no estado de ativação, inválido ou inativo.
Depuração
Cabeçalho da requisição
Esta operação utiliza apenas parâmetros de requisição comuns. Para mais informações, consulte Parâmetros comuns.
Sintaxe da requisição
PATCH|POST /openapi/instances/[InstanceId]/public-network HTTPS|HTTPParâmetros da requisição
|
Parâmetro |
Tipo |
Obrigatório |
Exemplo |
Descrição |
|
InstanceId |
String |
Sim |
es-cn-nif1q9o8r0008**** |
ID da instância. |
|
clientToken |
String |
Não |
5A2CFF0E-5718-45B5-9D4D-70B3FF**** |
Token exclusivo gerado pelo cliente para garantir a idempotência da requisição. Gere o valor com o cliente e garanta que seja único entre diferentes requisições. O token pode conter apenas caracteres ASCII e não deve exceder 64 caracteres. |
RequestBody
Também é possível informar o parâmetro enablePublic no RequestBody (opcional). O valor padrão é false. Tipo booleano. O valor true indica que o acesso ao endpoint público está ativado. O valor false indica que o acesso ao endpoint público está desativado. Exemplo:
Você também pode insira o parâmetro enablePublic no RequestBody (opcional, o padrão é false). Tipo booleano. True significa que o acesso ao endereço de rede pública está ativado e false significa desativado. Exemplo:
{
"enablePublic": true
}
Parâmetros de resposta
|
Parâmetro |
Tipo |
Exemplo |
Descrição |
|
RequestId |
String |
2A88ECA1-D827-4581-AD39-05149586**** |
ID da requisição. |
|
Result |
Struct |
Resultados retornados. |
|
|
enablePublic |
Boolean |
false |
Status do interruptor de acesso à rede pública. |
Os exemplos de resposta a seguir servem apenas como referência. Para mais informações sobre as descrições dos parâmetros, consulte
. O programa não deve depender obrigatoriamente da obtenção desses parâmetros.
Exemplos
Exemplos de requisições
PATCH /openapi/instances/es-cn-nif1q9o8r0008****/public-network HTTP/1.1
Common request parameters
{
"enablePublic": true
}Exemplos de respostas de sucesso
Formato JSON
{
"Result": {
"instanceId": "es-cn-nif1q9o8r0008****",
"version": "6.7.0_with_X-Pack",
"description": "es-cn-nif1q9o8r0008****",
"nodeAmount": 4,
"paymentType": "postpaid",
"status": "active",
"privateNetworkIpWhiteList": [
"0.0.0.0/0"
],
"enablePublic": true,
"nodeSpec": {
"spec": "elasticsearch.n4.small",
"disk": 20,
"diskType": "cloud_ssd",
"diskEncryption": false
},
"networkConfig": {
"vpcId": "vpc-bp16k1dvzxtmagcva****",
"vswitchId": "vsw-bp1k4ec6s7sjdbudw****",
"vsArea": "cn-hangzhou-i",
"type": "vpc"
},
"createdAt": "2020-07-07T04:05:16.791Z",
"updatedAt": "2020-07-07T10:15:14.498Z",
"commodityCode": "elasticsearch",
"extendConfigs": [
{
"configType": "usageScenario",
"value": "general"
},
{
"configType": "maintainTime",
"maintainStartTime": "02:00Z",
"maintainEndTime": "06:00Z"
},
{
"configType": "aliVersion",
"aliVersion": "ali1.2.0"
}
],
"endTime": 4749811200000,
"clusterTasks": [
{
"type": "MigrateData",
"progress": 100,
"detail": {},
"status": "FINISHED",
"canCancelable": false,
"interruptible": false,
"subTasks": [
{
"type": "FindShrinkNodeAction",
"progress": 100,
"detail": {},
"status": "FINISHED",
"canCancelable": false,
"interruptible": false,
"subTasks": []
},
{
"type": "MigrateDataAction",
"progress": 100,
"detail": {
"doneMigrateNodeIps": [
"172.16. **.**"
],
"allMigrateNodeIps": [
"172.16. **.**"
]
},
"status": "FINISHED",
"canCancelable": false,
"interruptible": false,
"subTasks": []
}
]
}
],
"vpcInstanceId": "es-cn-nif1q9o8r0008****-worker",
"resourceGroupId": "rg-acfm2h5vbzdokea",
"zoneCount": 1,
"protocol": "HTTP",
"zoneInfos": [
{
"zoneId": "cn-hangzhou-i",
"status": "NORMAL"
}
],
"instanceType": "elasticsearch",
"inited": true,
"tags": [],
"domain": "es-cn-nif1q9o8r0008****.elasticsearch.aliyuncs.com",
"port": 9200,
"esVersion": "6.7.0_with_X-Pack",
"esConfig": {
"thread_pool.bulk.queue_size": "500"
},
"esIPWhitelist": [
"0.0.0.0/0"
],
"esIPBlacklist": [],
"kibanaIPWhitelist": [
"0.0.0.0/0",
"::/0"
],
"kibanaPrivateIPWhitelist": [],
"publicIpWhitelist": [],
"kibanaDomain": "es-cn-nif1q9o8r0008****.kibana.elasticsearch.aliyuncs.com",
"kibanaPort": 5601,
"haveKibana": true,
"instanceCategory": "x-pack",
"dedicateMaster": false,
"advancedDedicateMaster": false,
"masterConfiguration": {},
"haveClientNode": false,
"warmNode": false,
"warmNodeConfiguration": {},
"clientNodeConfiguration": {},
"kibanaConfiguration": {
"spec": "elasticsearch.n4.small",
"amount": 1,
"disk": 0
},
"dictList": [
{
"name": "SYSTEM_MAIN.dic",
"fileSize": 2782602,
"sourceType": "ORIGIN",
"type": "MAIN"
},
{
"name": "SYSTEM_STOPWORD.dic",
"fileSize": 132,
"sourceType": "ORIGIN",
"type": "STOP"
}
],
"synonymsDicts": [
{
"name": "dict_0.txt",
"fileSize": 220,
"sourceType": "ORIGIN",
"type": "SYNONYMS"
}
],
"ikHotDicts": [],
"aliwsDicts": [],
"haveGrafana": false,
"haveCerebro": false,
"enableKibanaPublicNetwork": true,
"enableKibanaPrivateNetwork": false,
"advancedSetting": {
"gcName": "CMS"
}
},
"RequestId": "17632473-6A3B-4D0C-A603-A56D5743****"
}Códigos de erro
|
HttpCode |
Código de erro |
Mensagem de erro |
Descrição |
|
400 |
InstanceNotFound |
The instanceId provided does not exist. |
Mensagem de erro retornada porque a instância especificada não foi encontrada. Verifique o status da instância. |
Para obter uma lista de códigos de erro, visite a Central de Erros de API.