Exemples d’utilisation de l’AWS CLI avec AWS Cloud Map

Pour créer un espace de noms HTTP

L’exemple create-http-namespace suivant crée un espace de noms HTTP example.com.

aws servicediscovery create-http-namespace \
    --name example.com \
    --creator-request-id example-request-id

Sortie :

{
    "OperationId": "gv4g5meo7ndmeh4fqskygvk23d2fijwa-k9302yzd"
}

Pour confirmer que l’opération a réussi, vous pouvez exécuter get-operation. Pour plus d’informations, consultez get-operation.

Pour plus d’informations sur la création d’un espace de noms, consultez Création d’un espace de noms AWS Cloud Map pour regrouper les services d’application dans le Manuel du développeur AWS Cloud Map.

Pour créer un espace de noms DNS privé

L’exemple create-private-dns-namespace suivant crée un espace de noms DNS privé.

aws servicediscovery create-private-dns-namespace \
    --name example.com \
    --vpc vpc-1c56417b

Sortie :

{
    "OperationId": "gv4g5meo7ndmeh4fqskygvk23d2fijwa-k9302yzd"
}

Pour confirmer que l’opération a réussi, vous pouvez exécuter get-operation. Pour plus d’informations, consultez get-operation.

Pour plus d’informations, consultez Création d’espaces de noms dans le Manuel du développeur AWS Cloud Map.

Pour créer un espace de noms DNS public

L’exemple create-public-dns-namespace suivant crée un espace de noms DNS public example.com.

aws servicediscovery create-public-dns-namespace \
    --name example-public-dns.com \
    --creator-request-id example-public-request-id \
    --properties DnsProperties={SOA={TTL=60}}

Sortie :

{
    "OperationId": "gv4g5meo7ndmeh4fqskygvk23d2fijwa-k9302yzd"
}

Pour confirmer que l’opération a réussi, vous pouvez exécuter get-operation.

Pour plus d’informations sur la création d’un espace de noms, consultez Création d’un espace de noms AWS Cloud Map pour regrouper les services d’application dans le Manuel du développeur AWS Cloud Map.

Pour créer un service

L’exemple create-service suivant crée un service.

aws servicediscovery create-service \
    --name myservice \
    --namespace-id  ns-ylexjili4cdxy3xm \
    --dns-config "NamespaceId=ns-ylexjili4cdxy3xm,RoutingPolicy=MULTIVALUE,DnsRecords=[{Type=A,TTL=60}]"

Sortie :

{
        "Service": {
        "Id": "srv-p5zdwlg5uvvzjita",
        "Arn": "arn:aws:servicediscovery:us-west-2:803642222207:service/srv-p5zdwlg5uvvzjita",
        "Name": "myservice",
        "NamespaceId": "ns-ylexjili4cdxy3xm",
        "DnsConfig": {
            "NamespaceId": "ns-ylexjili4cdxy3xm",
            "RoutingPolicy": "MULTIVALUE",
            "DnsRecords": [
                {
                    "Type": "A",
                    "TTL": 60
                }
            ]
        },
        "CreateDate": 1587081768.334,
        "CreatorRequestId": "567c1193-6b00-4308-bd57-ad38a8822d25"
    }
}

Pour plus d’informations, consultez Création de services dans le Manuel du développeur AWS Cloud Map.

Pour supprimer un espace de noms

L’exemple delete-namespace suivant supprime un espace de noms.

aws servicediscovery delete-namespace \
    --id ns-ylexjili4cdxy3xm

Sortie :

{
    "OperationId": "gv4g5meo7ndmeh4fqskygvk23d2fijwa-k98y6drk"
}

Pour confirmer que l’opération a réussi, vous pouvez exécuter get-operation. Pour plus d’informations, consultez get-operation.

Pour plus d’informations, consultez Suppression d’espaces de noms dans le Manuel du développeur AWS Cloud Map.

Pour supprimer un attribut de service

L’exemple delete-service-attributes suivant supprime un attribut de service avec la clé Port associée au service spécifié.

aws servicediscovery delete-service-attributes \
    --service-id srv-e4anhexample0004 \
    --attributes Port

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Suppression d’espaces de noms dans le Manuel du développeur AWS Cloud Map.

Pour supprimer un service

L’exemple delete-service suivant supprime un service.

aws servicediscovery delete-service \
    --id srv-p5zdwlg5uvvzjita

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Suppression de services dans le Manuel du développeur AWS Cloud Map.

Pour annuler l'enregistrement d'une instance de service

L’exemple deregister-instance suivant annule l’enregistrement d’une instance de service.

aws servicediscovery deregister-instance \
    --service-id srv-p5zdwlg5uvvzjita \
    --instance-id myservice-53

Sortie :

{
    "OperationId": "4yejorelbukcjzpnr6tlmrghsjwpngf4-k98rnaiq"
}

Pour confirmer que l’opération a réussi, vous pouvez exécuter get-operation. Pour plus d’informations, consultez get-operation.

Pour plus d’informations, consultez Annulation de l’enregistrement d’instances de service dans le Manuel du développeur AWS Cloud Map.

Pour découvrir la révision d’une instance

L’exemple discover-instances-revision suivant découvre la révision croissante d’une instance.

aws servicediscovery discover-instances-revision \
    --namespace-name example.com \
    --service-name myservice

Sortie :

{
    "InstancesRevision": 123456
}

Pour plus d’informations, consultez AWS Cloud Map service instances dans le Manuel du développeur AWS Cloud Map.

Pour découvrir les instances enregistrées

L’exemple discover-instances suivant découvre les instances enregistrées.

aws servicediscovery discover-instances \
    --namespace-name example.com \
    --service-name myservice \
    --max-results 10 \
    --health-status ALL

Sortie :

{
    "Instances": [
        {
            "InstanceId": "myservice-53",
            "NamespaceName": "example.com",
            "ServiceName": "myservice",
            "HealthStatus": "UNKNOWN",
            "Attributes": {
                "AWS_INSTANCE_IPV4": "172.2.1.3",
                "AWS_INSTANCE_PORT": "808"
            }
        }
    ]
}

Pour plus d’informations, consultez AWS Cloud Map service instances dans le Manuel du développeur AWS Cloud Map.

Pour obtenir les informations d’une instance

L’exemple get-instance suivant obtient les attributs d’un service.

aws servicediscovery get-instance \
    --service-id srv-e4anhexample0004
    --instance-id i-abcd1234

Sortie :

{
    "Instances": {
        "Id": "arn:aws:servicediscovery:us-west-2:111122223333;:service/srv-e4anhexample0004",
        "Attributes": {
            "AWS_INSTANCE_IPV4": "192.0.2.44",
            "AWS_INSTANCE_PORT": "80",
            "color": "green",
            "region": "us-west-2",
            "stage": "beta"
        }
    }
}

Pour plus d’informations, consultez AWS Cloud Map service instances dans le Manuel du développeur AWS Cloud Map.

Pour obtenir le statut de l’état des instances associées à un service

L’exemple get-instances-health-status suivant obtient le statut de l’état des instances associées au service spécifié.

aws servicediscovery get-instances-health-status \
    --service-id srv-e4anhexample0004

Sortie :

{
    "Status": {
        "i-abcd1234": "HEALTHY",
        "i-abcd1235": "UNHEALTHY"
    }
}

Pour plus d’informations, consultez AWS Cloud Map service instances dans le Manuel du développeur AWS Cloud Map.

Pour obtenir les informations d’un espace de noms

L’exemple get-namespace suivant récupère les informations sur l’espace de noms spécifié.

aws servicediscovery get-namespace \
    --id ns-e4anhexample0004

Sortie :

{
    "Namespaces": {
        "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-e4anhexample0004",
        "CreateDate": "20181118T211712Z",
        "CreatorRequestId": "example-creator-request-id-0001",
        "Description": "Example.com AWS Cloud Map HTTP Namespace",
        "Id": "ns-e4anhexample0004",
        "Name": "example-http.com",
        "Properties": {
            "DnsProperties": {},
            "HttpProperties": {
                "HttpName": "example-http.com"
            }
        },
        "Type": "HTTP"
    }
}

Pour plus d’informations, consultez Espaces de noms AWS Cloud Map dans le Manuel du développeur AWS Cloud Map.

Pour obtenir le résultat d’une opération

L’exemple get-operation suivant obtient le résultat d’une opération de création d’un espace de noms.

aws servicediscovery get-operation \
    --operation-id gv4g5meo7ndmeh4fqskygvk23d2fijwa-k9302yzd

Sortie :

{
    "Operation": {
        "Id": "gv4g5meo7ndmeh4fqskygvk23d2fijwa-k9302yzd",
        "Type": "CREATE_NAMESPACE",
        "Status": "SUCCESS",
        "CreateDate": 1587055860.121,
        "UpdateDate": 1587055900.469,
        "Targets": {
            "NAMESPACE": "ns-ylexjili4cdxy3xm"
        }
    }
}

Pour plus d’informations, consultez Création d’un espace de noms AWS Cloud Map pour regrouper les services d’application dans le Manuel du développeur AWS Cloud Map.

Pour obtenir les attributs d’un service

L’exemple get-service-attributes suivant obtient les attributs d’un service.

aws servicediscovery get-service-attributes \
    --service-id srv-e4anhexample0004

Sortie :

{
    "ServiceAttributes": {
        "ServiceArn": "arn:aws:servicediscovery:us-west-2:111122223333;:service/srv-e4anhexample0004",
        "Attributes": {
            "Port": "80"
        }
    }
}

Pour plus d’informations, consultez AWS Cloud Map services dans le Manuel du développeur AWS Cloud Map.

Pour obtenir les paramètres d’un service

L’exemple get-service suivant obtient les paramètres du service spécifié.

aws servicediscovery get-service \
    --id srv-e4anhexample0004

Sortie :

{
    "Service": {
        "Id": "srv-e4anhexample0004",
        "Arn": "arn:aws:servicediscovery:us-west-2:111122223333:service/srv-e4anhexample0004",
        "Name": "test-service",
        "NamespaceId": "ns-e4anhexample0004",
        "DnsConfig": {},
        "Type": "HTTP",
        "CreateDate": "2025-02-24T10:59:02.905000-06:00",
        "CreatorRequestId": "3f50f9d9-b14c-482e-a556-d2a22fe6106d"
    }
}

Pour plus d’informations, consultez AWS Cloud Map services dans le Manuel du développeur AWS Cloud Map.

Pour répertorier les instances de service

L’exemple list-instances suivant répertorie les instances de service.

aws servicediscovery list-instances \
    --service-id srv-qzpwvt2tfqcegapy

Sortie :

{
    "Instances": [
        {
            "Id": "i-06bdabbae60f65a4e",
            "Attributes": {
                "AWS_INSTANCE_IPV4": "172.2.1.3",
                "AWS_INSTANCE_PORT": "808"
            }
        }
    ]
}

Pour plus d’informations, consultez Affichage d’une liste d’instances de service dans le Manuel du développeur AWS Cloud Map.

Pour répertorier des espaces de noms

L’exemple list-namespaces suivant répertorie des espaces de noms.

aws servicediscovery list-namespaces

Sortie :

{
    "Namespaces": [
        {
            "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-a3ccy2e7e3a7rile",
            "CreateDate": 1585354387.357,
            "Id": "ns-a3ccy2e7e3a7rile",
            "Name": "local",
            "Properties": {
                "DnsProperties": {
                    "HostedZoneId": "Z06752353VBUDTC32S84S"
                },
                "HttpProperties": {
                    "HttpName": "local"
                 }
            },
            "Type": "DNS_PRIVATE"
        },
        {
            "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-pocfyjtrsmwtvcxx",
            "CreateDate": 1586468974.698,
            "Description": "My second namespace",
            "Id": "ns-pocfyjtrsmwtvcxx",
            "Name": "My-second-namespace",
            "Properties": {
                "DnsProperties": {},
                "HttpProperties": {
                    "HttpName": "My-second-namespace"
                }
            },
            "Type": "HTTP"
        },
        {
            "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-ylexjili4cdxy3xm",
            "CreateDate": 1587055896.798,
            "Id": "ns-ylexjili4cdxy3xm",
            "Name": "example.com",
            "Properties": {
                "DnsProperties": {
                    "HostedZoneId": "Z09983722P0QME1B3KC8I"
                },
                 "HttpProperties": {
                     "HttpName": "example.com"
                }
            },
            "Type": "DNS_PRIVATE"
        }
    ]
}

Pour plus d’informations, consultez Affichage d’une liste d’espaces de noms dans le Manuel du développeur AWS Cloud Map.

Pour répertorier les opérations qui répondent aux critères spécifiés

L’exemple list-operations suivant répertorie les opérations dont le statut est PENDING ou SUCCESS.

aws servicediscovery list-operations \
    --service-id srv-e4anhexample0004 \
    --filters Name=STATUS,Condition=IN,Values=PENDING,SUCCESS

Sortie :

{
    "Operations": [
        {
            "Id": "76yy8ovhpdz0plmjzbsnqgnrqvpv2qdt-kexample",
            "Status": "SUCCESS"
        },
        {
            "Id": "prysnyzpji3u2ciy45nke83x2zanl7yk-dexample",
            "Status": "SUCCESS"
        },
        {
            "Id": "ko4ekftir7kzlbechsh7xvcdgcpk66gh-7example",
            "Status": "PENDING"
        }
    ]
}

Pour plus d’informations, consultez Qu’est-ce que AWS Cloud Map ? dans le Manuel du développeur AWS Cloud Map.

Pour répertorier des services

L’exemple list-services suivant répertorie des services.

aws servicediscovery list-services

Sortie :

{
    "Services": [
        {
            "Id": "srv-p5zdwlg5uvvzjita",
            "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-p5zdwlg5uvvzjita",
            "Name": "myservice",
            "DnsConfig": {
                "RoutingPolicy": "MULTIVALUE",
                "DnsRecords": [
                    {
                        "Type": "A",
                        "TTL": 60
                    }
                ]
            },
            "CreateDate": 1587081768.334
        }
    ]
}

Pour plus d’informations, consultez Viewing a list of services dans le Manuel du développeur AWS Cloud Map.

Pour répertorier les balises associées à la ressource spécifiée

L’exemple list-tags-for-resource suivant répertorie les balises de la ressource spécifiée.

aws servicediscovery list-tags-for-resource \
    --resource-arn arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-e4anhexample0004

Sortie :

{
    "Tags": [
        {
            "Key": "Project",
            "Value": "Zeta"
        },
        {
            "Key": "Department",
            "Value": "Engineering"
        }
    ]
}

Pour plus d’informations, consultez Tagging your AWS Cloud Map resources dans le Manuel du développeur AWS Cloud Map.

Pour enregistrer une instance de service

L’exemple register-instance suivant enregistre une instance de service.

aws servicediscovery register-instance \
    --service-id srv-p5zdwlg5uvvzjita \
    --instance-id myservice-53 \
    --attributes=AWS_INSTANCE_IPV4=172.2.1.3,AWS_INSTANCE_PORT=808

Sortie :

{
    "OperationId": "4yejorelbukcjzpnr6tlmrghsjwpngf4-k95yg2u7"
}

Pour confirmer que l’opération a réussi, vous pouvez exécuter get-operation. Pour plus d’informations, consultez get-operation.

Pour plus d’informations, consultez Enregistrement d’instances dans le Manuel du développeur AWS Cloud Map.

Pour associer des balises à la ressource spécifiée

L’exemple tag-resource suivant associe une balise Department avec la valeur Engineering à l’espace de noms spécifié.

aws servicediscovery tag-resource \
    --resource-arn arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-e4anhexample0004 \
    --tags Key=Department, Value=Engineering

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Tagging your AWS Cloud Map resources dans le Manuel du développeur AWS Cloud Map.

Pour supprimer des balises de la ressource spécifiée

L’exemple untag-resource suivant supprime une balise Department de l’espace de noms spécifié.

aws servicediscovery untag-resource \
    --resource-arn arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-e4anhexample0004 \
    --tags Key=Department, Value=Engineering

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Tagging your AWS Cloud Map resources dans le Manuel du développeur AWS Cloud Map.

Pour mettre à jour un espace de noms HTTP

L’exemple update-http-namespace suivant met à jour la description de l’espace de noms HTTP spécifié.

aws servicediscovery update-http-namespace \
    --id ns-vh4nbmEXAMPLE \
    --updater-request-id example-request-id \
    --namespace Description="The updated namespace description."

Sortie :

{
    "OperationId": "gv4g5meo7ndmeh4fqskygvk23d2fijwa-k9302yzd"
}

Pour confirmer que l’opération a réussi, vous pouvez exécuter get-operation. Pour plus d’informations, consultez get-operation.

Pour plus d’informations, consultez Espaces de noms AWS Cloud Map dans le Manuel du développeur AWS Cloud Map.

Pour mettre à jour une surveillance de l’état personnalisée

L’exemple update-instance-custom-health-status suivant met à jour le statut de la surveillance de l’état personnalisée pour le service spécifié et l’exemple d’instance de service sur HEALTHY.

aws servicediscovery update-instance-custom-health-status \
    --service-id srv-e4anhexample0004 \
    --instance-id example \
    --status HEALTHY

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Configuration de la surveillance de l’état du service AWS Cloud Map dans le Manuel du développeur AWS Cloud Map.

Pour mettre à jour un espace de noms DNS privé

L’exemple update-private-dns-namespace suivant met à jour la description d’un espace de noms DNS privé.

aws servicediscovery update-private-dns-namespace \
    --id ns-bk3aEXAMPLE \
    --updater-request-id example-private-request-id \
    --namespace Description="The updated namespace description."

Sortie :

{
    "OperationId": "gv4g5meo7ndmeh4fqskygvk23d2fijwa-k9302yzd"
}

Pour confirmer que l’opération a réussi, vous pouvez exécuter get-operation.

Pour plus d’informations, consultez Espaces de noms AWS Cloud Map dans le Manuel du développeur AWS Cloud Map.

Pour mettre à jour un espace de noms DNS public

L’exemple update-public-dns-namespace suivant met à jour la description d’un espace de noms DNS public.

aws servicediscovery update-public-dns-namespace \
    --id ns-bk3aEXAMPLE \
    --updater-request-id example-public-request-id \
    --namespace Description="The updated namespace description."

Sortie :

{
    "OperationId": "gv4g5meo7ndmeh4fqskygvk23d2fijwa-k9302yzd"
}

Pour confirmer que l’opération a réussi, vous pouvez exécuter get-operation.

Pour plus d’informations, consultez Espaces de noms AWS Cloud Map dans le Manuel du développeur AWS Cloud Map.

Pour mettre à jour un service afin d’ajouter un attribut

L’exemple update-service-attributes suivant met à jour le service spécifié pour ajouter un attribut de service avec une clé Port et une valeur 80.

aws servicediscovery update-service-attributes \
    --service-id srv-e4anhexample0004 \
    --attributes Port=80

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez AWS Cloud Map services dans le Manuel du développeur AWS Cloud Map.

Pour mettre à jour un service

L’exemple update-service suivant met à jour un service pour mettre à jour les paramètres DnsConfig et HealthCheckConfig.

aws servicediscovery update-service \
    --id srv-e4anhexample0004 \
    --service "DnsConfig={DnsRecords=[{"Type"="A","TTL"=60}]},HealthCheckConfig={"Type"="HTTP","ResourcePath"="/","FailureThreshold"="2"}"

Sortie :

{
    "OperationId": "gv4g5meo7ndmeh4fqskygvk23d2fijwa-k9302yzd"
}

Pour confirmer que l’opération a réussi, vous pouvez exécuter get-operation.

Pour plus d’informations sur la mise à jour d’un service, consultez Updating an AWS Cloud Map service dans le Manuel du développeur AWS Cloud Map.