ModifyWhiteIps - Update Elasticsearch IP address whitelist - Elasticsearch

Notes d'utilisation

N'appelez pas cette opération si l'instance est dans l'état Active (en cours d'activation), Invalid (invalide) ou Inactive (inactive).
Deux méthodes de mise à jour sont disponibles et ne peuvent pas être combinées. Outre InstanceId et clientToken, chaque méthode utilise des paramètres différents :
- Liste d'autorisation d'adresses IP : whiteIpList, nodeType et networkType
- Groupes de liste d'autorisation d'adresses IP : modifyMode et whiteIpGroup
Les listes d'autorisation pour le réseau public ne doivent pas contenir d'adresses IP privées, et les listes d'autorisation pour le réseau privé ne doivent pas contenir d'adresses IP publiques.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'appeler cette opération dans OpenAPI Explorer, qui génère dynamiquement un exemple de code pour différents SDK.

En-têtes de requête

Cette opération utilise uniquement les en-têtes de requête communs.

Syntaxe de la requête

PATCHPOST /openapi/instances/{InstanceId}/actions/modify-white-ips HTTP/1.1

Paramètres de requête

Parameter	Type	Position	Required	Example	Description
InstanceId	String	Path	Yes	es-cn-0pp1jxvcl000z****	ID de l'instance.
clientToken	String	Query	No	5A2CFF0E-5718-45B5-9D4D-70B3FF****	Jeton généré par le client utilisé pour garantir l'idempotence. Doit être unique pour toutes les requêtes. Longueur maximale : 64 caractères ASCII.
	Object	Body	No		Paramètres du corps de la requête.
nodeType	String	Body	No	WORKER	Type de nœud. Requis lorsque vous spécifiez whiteIpList. Valeurs valides : WORKER : cluster Elasticsearch KIBANA : cluster Kibana
networkType	String	Body	No	PUBLIC	Type de réseau. Requis lorsque vous spécifiez whiteIpList. Valeurs valides : PRIVATE : réseau privé PUBLIC : réseau public
modifyMode	String	Body	No	Cover	Méthode de modification. Valeurs valides : Cover (par défaut) : remplace la liste d'autorisation par les adresses IP spécifiées. Append : ajoute les adresses IP spécifiées à la liste d'autorisation existante. Delete : supprime les adresses IP spécifiées de la liste d'autorisation. Au moins une adresse IP doit rester.
whiteIpList	Array of String	Body	No	192.168.xx.xx	Liste d'autorisation d'adresses IP. Disponible uniquement lorsque whiteIpGroup n'est pas spécifié. Met à jour le groupe de liste d'autorisation Default. Important Vous ne pouvez pas configurer whiteIpList et whiteIpGroup en même temps.
whiteIpGroup	Object	Body	No		Met à jour les configurations de liste d'autorisation par groupe. Un seul groupe peut être mis à jour par requête. Important Vous ne pouvez pas configurer whiteIpList et whiteIpGroup en même temps.
groupName	String	Body	No	test_group	Nom du groupe de liste d'autorisation. Requis lorsque vous spécifiez whiteIpGroup.
ips	Array of String	Body	No	192.168.xx.xx	Adresses IP du groupe de liste d'autorisation. Requises lorsque vous spécifiez whiteIpGroup.
whiteIpType	String	Body	No	PRIVATE_ES	Type de liste d'autorisation d'adresses IP. Valeurs valides : PRIVATE_KIBANA : liste d'autorisation de réseau privé Kibana PRIVATE_ES : liste d'autorisation de réseau privé Elasticsearch PUBLIC_ES : liste d'autorisation de réseau public Elasticsearch PUBLIC_KIBANA : liste d'autorisation de réseau public Kibana

Important

Seul le mode Cover permet d'ajouter ou de supprimer des groupes de liste d'autorisation. Les modes Append et Delete ne peuvent modifier que les adresses IP au sein d'un groupe existant. Remarque :

Cover : si ips est vide, le groupe de liste d'autorisation est supprimé. Si groupName ne correspond à aucun groupe existant, un nouveau groupe est créé.
Delete : au moins une adresse IP doit rester après la suppression.
Append : le groupe de liste d'autorisation doit déjà exister. Sinon, une erreur NotFound est renvoyée.

Paramètres de réponse

Parameter

Type

Example

Description

Result

Boolean

true

Indique si la liste d'autorisation a été mise à jour.

true : La liste d'autorisation est mise à jour.
false : Échec de la mise à jour de la liste d'autorisation.

RequestId

String

5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1DERFG

ID de la requête.

Exemple

Exemple de requête

PATCH /openapi/instances/es-cn-0pp1jxvcl000z****/actions/modify-white-ips HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json
{
    "nodeType" : "WORKER",
    "networkType" : "PUBLIC",
    "whiteIpList": [
        "110.0.XX.XX/8"
    ]
}
or
{
    "modifyMode": "cover",
    "whiteIpGroup": {
        "groupName": "test_group_name", 
        "ips": [
            "0.0.0.0", 
            "10.2.XX.XX"
        ],
        "whiteIpType" : "PRIVATE_ES"
    }
}

Exemples de réponses réussies

XML format

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

<ModifyWhiteIpsResponse>
    <Result>true</Result>
    <RequestId>5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1DERFG</RequestId>
</ModifyWhiteIpsResponse>

JSON format

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

{
  "Result" : true,
  "RequestId" : "5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1DERFG"
}

Codes d'erreur

Les codes d'erreur sont répertoriés dans le Centre d'erreurs API.