Exemplos do AWS Cloud Map usando a AWS CLI - AWS Command Line Interface

Esta documentação é somente para a versão 1 da AWS CLI. Para obter a documentação relacionada à AWS CLI versão 2, consulte o Guia do usuário da versão 2.

Exemplos do AWS Cloud Map usando a AWS CLI

Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o AWS Cloud Map.

Ações são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.

Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.

Tópicos

Ações

O código de exemplo a seguir mostra como usar create-http-namespace.

AWS CLI

Como criar um namespace HTTP

O exemplo de create-http-namespace a seguir cria um namespace HTTP chamado example.com.

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

Resultado:

{ "OperationId": "gv4g5meo7ndmeh4fqskygvk23d2fijwa-k9302yzd" }

Para confirmar que a operação foi bem-sucedida, você pode executarget-operation. Para obter mais informações, consulte get-operation.

Para obter mais informações sobre como criar um namespace, consulte Creating an AWS Cloud Map namespace to group application services no Guia do desenvolvedor do AWS Cloud Map.

O código de exemplo a seguir mostra como usar create-private-dns-namespace.

AWS CLI

Para criar um namespace de DNS privado

O exemplo create-private-dns-namespace a seguir cria um namespace DNS privado.

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

Resultado:

{ "OperationId": "gv4g5meo7ndmeh4fqskygvk23d2fijwa-k9302yzd" }

Para confirmar que a operação foi bem-sucedida, você pode executarget-operation. Para obter mais informações, consulte get-operation.

Para obter mais informações, consulte Criar namespaces no Guia do desenvolvedor do AWS Cloud Map.

O código de exemplo a seguir mostra como usar create-public-dns-namespace.

AWS CLI

Como criar um namespace de DNS público

O exemplo de create-public-dns-namespace a seguir cria um namespace de DNS público chamado 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}}

Resultado:

{ "OperationId": "gv4g5meo7ndmeh4fqskygvk23d2fijwa-k9302yzd" }

Para confirmar que a operação foi bem-sucedida, você pode executarget-operation.

Para obter mais informações sobre como criar um namespace, consulte Creating an AWS Cloud Map namespace to group application services no Guia do desenvolvedor do AWS Cloud Map.

O código de exemplo a seguir mostra como usar create-service.

AWS CLI

Exemplo 1: criar um serviço usando o ID do namespace

O exemplo create-service a seguir cria um serviço.

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

Resultado:

{ "Service": { "Id": "srv-abcd1234xmpl5678", "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678", "ResourceOwner": "123456789012", "Name": "myservice", "NamespaceId": "ns-abcd1234xmpl5678", "DnsConfig": { "NamespaceId": "ns-abcd1234xmpl5678", "RoutingPolicy": "MULTIVALUE", "DnsRecords": [ { "Type": "A", "TTL": 60 } ] }, "Type": "DNS_HTTP", "CreateDate": "2025-08-18T13:45:31.023000-05:00", "CreatorRequestId": "abcd1234-5678-90ab-cdef-xmpl12345678", "CreatedByAccount": "123456789012" } }

Para ter mais informações, consulte Criar um serviço do AWS Cloud Map para um componente da aplicação no Guia do desenvolvedor do AWS Cloud Map.

Exemplo 2: criar um serviço usando o ARN do namespace

O exemplo de create-service a seguir cria um serviço usando um ARN de namespace em vez de um ID de namespace. É necessário especificar um ARN de namespace ao criar um serviço em um namespace compartilhado.

aws servicediscovery create-service \ --name myservice-arn \ --namespace-id arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-abcd1234xmpl5678 \ --dns-config "RoutingPolicy=MULTIVALUE,DnsRecords=[{Type=A,TTL=60}]"

Resultado:

{ "Service": { "Id": "srv-abcd1234xmpl5678", "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678", "ResourceOwner": "123456789012", "Name": "myservice-arn", "NamespaceId": "ns-abcd1234xmpl5678", "DnsConfig": { "NamespaceId": "ns-abcd1234xmpl5678", "RoutingPolicy": "MULTIVALUE", "DnsRecords": [ { "Type": "A", "TTL": 60 } ] }, "Type": "DNS_HTTP", "CreateDate": "2025-08-18T13:45:31.023000-05:00", "CreatorRequestId": "abcd1234-5678-90ab-cdef-xmpl12345678", "CreatedByAccount": "123456789012" } }

Para ter mais informações, consulte Namespaces compartilhados do AWS Cloud Map no Guia do desenvolvedor do AWS Cloud Map.

  • Consulte detalhes da API em CreateService na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-namespace.

AWS CLI

Exemplo 1: excluir um namespace

O exemplo delete-namespace a seguir exclui um namespace.

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

Resultado:

{ "OperationId": "abcd1234-5678-90ab-cdef-xmpl12345678" }

Para confirmar que a operação foi bem-sucedida, você pode executarget-operation. Para obter mais informações, consulte get-operation.

Para ter mais informações, consulte Excluir um namespace do AWS Cloud Map no Guia do desenvolvedor do AWS Cloud Map.

Exemplo 2: excluir um namespace usando o ARN do namespace

O exemplo de delete-namespace a seguir exclui um namespace usando o respectivo ARN.

aws servicediscovery delete-namespace \ --id arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-abcd1234xmpl5678

Resultado:

{ "OperationId": "abcd1234-5678-90ab-cdef-xmpl12345678" }

Para ter mais informações, consulte Excluir um namespace do AWS Cloud Map no Guia do desenvolvedor do AWS Cloud Map.

  • Para ver detalhes da API, consulte DeleteNamespace na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-service-attributes.

AWS CLI

Exemplo 1: excluir um atributo de serviço

O exemplo de delete-service-attributes a seguir exclui um atributo de serviço com a chave Port associada ao serviço especificado.

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

Este comando não produz saída.

Para obter mais informações, consulte AWS Cloud Map services no Guia do desenvolvedor do AWS Cloud Map.

Exemplo 2: excluir um atributo de serviço usando o ARN

O exemplo de delete-service-attributes a seguir exclui um atributo de serviço usando o ARN do serviço. A especificação do ARN é necessária para excluir atributos associados aos serviços criados em namespaces compartilhados com sua conta.

aws servicediscovery delete-service-attributes \ --service-id arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678 \ --attributes Port

Este comando não produz saída.

Para ter mais informações, consulte Serviços do AWS Cloud Map e Namespaces compartilhados do AWS Cloud Map no Guia do desenvolvedor do AWS.

O código de exemplo a seguir mostra como usar delete-service.

AWS CLI

Exemplo 1: excluir um serviço

O exemplo delete-service a seguir exclui um serviço.

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

Este comando não produz saída.

Para ter mais informações, consulte Excluir um serviço do AWS no Guia do desenvolvedor do AWS Cloud Map.

Exemplo 2: excluir um serviço usando o ARN

O exemplo de delete-service a seguir exclui um serviço usando o respectivo ARN.

aws servicediscovery delete-service \ --id arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678

Este comando não produz saída.

Para ter mais informações, consulte Excluir um serviço do AWS no Guia do desenvolvedor do AWS Cloud Map.

  • Consulte detalhes da API em DeleteService na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar deregister-instance.

AWS CLI

Exemplo 1: cancelar o registro de uma instância de serviço

O exemplo deregister-instance a seguir cancela o registro de uma instância de serviço.

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

Resultado:

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

Para confirmar que a operação foi bem-sucedida, você pode executarget-operation. Para ter mais informações, consulte get-operation.

Para obter mais informações, consulte Cancelar o registro de instâncias de serviço no Guia do desenvolvedor do AWS Cloud Map.

Exemplo 2: cancelar o registro de uma instância de serviço usando o ARN do serviço para namespaces compartilhados

O exemplo de deregister-instance a seguir cancela o registro de uma instância de serviço usando um ARN de serviço em vez de um ID de serviço. É necessário especificar um ARN ao cancelar o registro de instâncias de serviço criadas em namespaces compartilhados com sua conta.

aws servicediscovery deregister-instance \ --service-id arn:aws:servicediscovery:us-west-2:123456789012:service/srv-p5zdwlg5uvvzjita \ --instance-id web-server-01

Resultado:

{ "OperationId": "gv4g5meo7ndmkqjrhpn39wk42xmpl" }

Para ter mais informações, consulte Namespaces compartilhados do AWS Cloud Map e Cancelar o registro de uma instância de serviço do AWS Cloud Map no Guia do desenvolvedor do AWS.

  • Para ver detalhes da API, consulte DeregisterInstance na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar discover-instances-revision.

AWS CLI

Exemplo 1: descobrir a análise de uma instância

O exemplo de discover-instances-revision a seguir descobre a revisão crescente de uma instância.

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

Resultado:

{ "InstancesRevision": 123456 }

Para obter mais informações, consulte AWS Cloud Map service instances no Guia do desenvolvedor do AWS Cloud Map.

Exemplo 2: descobrir a análise de instâncias de uma conta de proprietário específica

O exemplo de discover-instances-revision a seguir mostra a análise de instâncias de uma conta de proprietário específica. O parâmetro owner-account é necessário para instâncias em namespaces compartilhados com sua conta.

aws servicediscovery discover-instances-revision \ --namespace-name shared-namespace \ --service-name shared-service \ --owner-account 123456789111

Resultado:

{ "InstancesRevision": 1234567890 }

Para ter mais informações, consulte Namespaces compartilhados do AWS Cloud Map e Instâncias do serviço AWS Cloud Map no Guia do desenvolvedor do AWS Cloud Map.

O código de exemplo a seguir mostra como usar discover-instances.

AWS CLI

Exemplo 1: descobrir instâncias registradas

O exemplo discover-instances a seguir descobre instâncias registradas.

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

Resultado:

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

Para obter mais informações, consulte AWS Cloud Map service instances no Guia do desenvolvedor do AWS Cloud Map.

Exemplo 2: descobrir instâncias de uma conta de proprietário específica

O exemplo de discover-instances a seguir descobre instâncias registradas de uma conta de proprietário específica. Esse parâmetro é necessário para descobrir instâncias em namespaces são compartilhados com sua conta.

aws servicediscovery discover-instances \ --namespace-name shared-namespace \ --service-name shared-service \ --owner-account 123456789111

Resultado:

{ "Instances": [ { "InstanceId": "shared-instance-1234", "NamespaceName": "shared-namespace", "ServiceName": "shared-service", "HealthStatus": "HEALTHY", "Attributes": { "AWS_INSTANCE_IPV4": "203.0.113.75", "AWS_INSTANCE_PORT": "80" } } ], "InstancesRevision": 1234567890 }

Para ter mais informações, consulte Namespaces compartilhados do AWS Cloud Map e Instâncias do serviço AWS Cloud Map no Guia do desenvolvedor do AWS Cloud Map.

  • Para ver detalhes da API, consulte DiscoverInstances na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-instance.

AWS CLI

Exemplo 1: obter detalhes de uma instância

O exemplo de get-instance a seguir obtém os atributos de um serviço.

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

Resultado:

{ "ResourceOwner": "123456789012", "Instance": { "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" }, "CreatedByAccount": "123456789012" } }

Para obter mais informações, consulte AWS Cloud Map service instances no Guia do desenvolvedor do AWS Cloud Map.

Exemplo 2: obter detalhes de uma instância usando o ARN do serviço para namespaces compartilhados

O exemplo de get-instance a seguir obtém os atributos de uma instância usando um ARN de serviço em vez de um ID de serviço. É necessário especificar um ARN ao obter detalhes de instâncias associadas a namespaces compartilhados com sua conta. A instância exibida neste exemplo foi registrada pela conta 123456789111 em um namespace de propriedade da conta 123456789012.

aws servicediscovery get-instance \ --service-id arn:aws:servicediscovery:us-west-2:123456789012:service/srv-p5zdwlg5uvvzjita \ --instance-id web-server-01

Resultado:

{ "ResourceOwner": "123456789012", "Instance": { "Id": "web-server-01", "Attributes": { "AWS_INSTANCE_IPV4": "203.0.113.15", "AWS_INSTANCE_PORT": "80" }, "CreatedByAccount": "123456789111" } }

Para ter mais informações sobre compartilhamento de namespaces entre contas, consulte Namespaces compartilhados do AWS Cloud Map no Guia do desenvolvedor do AWS Cloud Map.

  • Para ver detalhes da API, consulte GetInstance na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-instances-health-status.

AWS CLI

Exemplo 1: obter o status de integridade das instâncias associadas a um serviço

O exemplo de get-instances-health-status a seguir obtém o status de integridade das instâncias associadas ao serviço especificado.

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

Resultado:

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

Para obter mais informações, consulte AWS Cloud Map service instances no Guia do desenvolvedor do AWS Cloud Map.

Exemplo 2: obter o status de integridade das instâncias usando o ARN do serviço para namespaces compartilhados

O exemplo de get-instances-health-status a seguir obtém o status de integridade das instâncias usando um ARN de serviço em vez de um ID de serviço. É necessário especificar um ARN ao obter o status de integridade das instâncias associadas a namespaces compartilhados com a conta do solicitante.

aws servicediscovery get-instances-health-status \ --service-id arn:aws:servicediscovery:us-west-2:123456789012:service/srv-p5zdwlg5uvvzjita

Resultado:

{ "Status": { "web-server-01": "HEALTHY", "web-server-02": "UNHEALTHY" } }

Para ter mais informações, consulte Instâncias do serviço AWS Cloud Map e Namespaces compartilhados do AWS Cloud Map no Guia do desenvolvedor do AWS Cloud Map.

O código de exemplo a seguir mostra como usar get-namespace.

AWS CLI

Exemplo 1: obter os detalhes de um namespace

O exemplo de get-namespace a seguir recupera informações sobre o namespace especificado.

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

Resultado:

{ "Namespace": { "Id": "ns-abcd1234xmpl5678", "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-abcd1234xmpl5678", "ResourceOwner": "123456789012", "Name": "example-http.com", "Type": "HTTP", "Description": "Example.com AWS Cloud Map HTTP Namespace", "Properties": { "DnsProperties": {}, "HttpProperties": { "HttpName": "example-http.com" } }, "CreateDate": "2024-02-23T13:35:21.874000-06:00", "CreatorRequestId": "abcd1234-5678-90ab-cdef-xmpl12345678" } }

Para obter mais informações, consulte AWS Cloud Map namespaces no Guia do desenvolvedor do AWS Cloud Map.

Exemplo 2: obter os detalhes de um namespace usando o ARN

O exemplo de get-namespace a seguir recupera informações sobre o namespace especificado usando o respectivo ARN. A especificação do ARN é necessária para recuperar detalhes de um namespace compartilhado com sua conta.

aws servicediscovery get-namespace \ --id arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-abcd1234xmpl5678

Resultado:

{ "Namespace": { "Id": "ns-abcd1234xmpl5678", "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-abcd1234xmpl5678", "ResourceOwner": "123456789012", "Name": "example-http.com", "Type": "HTTP", "Description": "Example.com AWS Cloud Map HTTP Namespace", "Properties": { "DnsProperties": {}, "HttpProperties": { "HttpName": "example-http.com" } }, "CreateDate": "2024-02-23T13:35:21.874000-06:00", "CreatorRequestId": "abcd1234-5678-90ab-cdef-xmpl12345678" } }

Para ter mais informações, consulte Namespaces compartilhados do AWS Cloud Map no Guia do desenvolvedor do AWS Cloud Map.

  • Para ver detalhes da API, consulte GetNamespace na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-operation.

AWS CLI

Exemplo 1: obter o resultado de uma operação

O exemplo de get-operation a seguir obtém o resultado da operação de criação de um namespace.

aws servicediscovery get-operation \ --operation-id abcd1234xmpl5678abcd1234xmpl5678-abcd1234

Resultado:

{ "Operation": { "Id": "abcd1234xmpl5678abcd1234xmpl5678-abcd1234", "Type": "CREATE_NAMESPACE", "Status": "SUCCESS", "CreateDate": "2025-01-13T13:35:21.874000-06:00", "UpdateDate": "2025-01-13T13:36:02.469000-06:00", "Targets": { "NAMESPACE": "ns-abcd1234xmpl5678" } } }

Para obter mais informações, consulte Creating an AWS Cloud Map namespace to group application services no Guia do desenvolvedor do AWS Cloud Map.

Exemplo 2: obter uma operação de uma conta de proprietário específica

O exemplo de get-operation a seguir obtém o resultado de uma operação associada a uma conta de proprietário de namespace específica. Esse parâmetro é necessário para obter o resultado das operações associadas aos namespaces compartilhados com sua conta.

aws servicediscovery get-operation \ --operation-id abcd1234xmpl5678abcd1234xmpl5678-abcd1234 \ --owner-account 123456789111

Resultado:

{ "Operation": { "Id": "abcd1234xmpl5678abcd1234xmpl5678-abcd1234", "OwnerAccount": "123456789111", "Type": "CREATE_NAMESPACE", "Status": "SUCCESS", "CreateDate": "2025-01-13T13:35:21.874000-06:00", "UpdateDate": "2025-01-13T13:36:02.469000-06:00", "Targets": { "NAMESPACE": "ns-abcd1234xmpl5678" } } }

Para ter mais informações, consulte Namespaces compartilhados do AWS Cloud Map no Guia do desenvolvedor do AWS Cloud Map.

  • Para ver detalhes da API, consulte GetOperation na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-service-attributes.

AWS CLI

Exemplo 1: obter os atributos de um serviço

O exemplo de get-service-attributes a seguir obtém os atributos de um serviço.

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

Resultado:

{ "ServiceAttributes": { "ServiceArn": "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678", "ResourceOwner": "123456789012", "Attributes": { "Port": "80" } } }

Para obter mais informações, consulte AWS Cloud Map services no Guia do desenvolvedor do AWS Cloud Map.

Exemplo 2: obter os atributos de um serviço usando o ARN

O exemplo de get-service-attributes a seguir obtém os atributos de um serviço usando o respectivo ARN. A especificação do ARN é necessária para obter os atributos de um serviço criado em um namespace compartilhado com sua conta.

aws servicediscovery get-service-attributes \ --service-id arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678

Resultado:

{ "ServiceAttributes": { "ServiceArn": "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678", "ResourceOwner": "123456789012", "Attributes": { "Port": "80" } } }

Para ter mais informações, consulte Serviços do AWS Cloud Map e Namespaces compartilhados do AWS Cloud Map no Guia do desenvolvedor do AWS.

O código de exemplo a seguir mostra como usar get-service.

AWS CLI

Exemplo 1: obter as configurações de um serviço

O exemplo de get-service a seguir obtém as configurações de um serviço especificado.

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

Resultado:

{ "Service": { "Id": "srv-abcd1234xmpl5678", "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678", "ResourceOwner": "123456789012", "Name": "test-service", "NamespaceId": "ns-abcd1234xmpl5678", "DnsConfig": {}, "Type": "HTTP", "CreateDate": "2025-08-18T13:53:02.775000-05:00", "CreatorRequestId": "abcd1234-5678-90ab-cdef-xmpl12345678", "CreatedByAccount": "123456789012" } }

Para obter mais informações, consulte AWS Cloud Map services no Guia do desenvolvedor do AWS Cloud Map.

Exemplo 2: obter as configurações de um serviço usando o ARN

O exemplo de get-service a seguir obtém as configurações de um serviço especificado usando o respectivo ARN. É necessário especificar o ARN ao recuperar informações sobre um serviço criado em um namespace compartilhado com sua conta. A conta do chamador 123456789111 criou o serviço em um namespace compartilhado pela conta 123456789012.

aws servicediscovery get-service \ --id arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678

Resultado:

{ "Service": { "Id": "srv-abcd1234xmpl5678", "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678", "ResourceOwner": "123456789012", "Name": "test-service", "NamespaceId": "ns-abcd1234xmpl5678", "DnsConfig": {}, "Type": "HTTP", "CreateDate": "2025-08-18T13:53:02.775000-05:00", "CreatorRequestId": "abcd1234-5678-90ab-cdef-xmpl12345678", "CreatedByAccount": "123456789111" } }

Para ter mais informações, consulte Criar um serviço do AWS Cloud Map para um componente da aplicação e Namespaces compartilhados do AWS Cloud Map no the Guia do desenvolvedor do AWS.

  • Para ver detalhes da API, consulte GetService na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-instances.

AWS CLI

Exemplo 1: listar instâncias de serviço

O exemplo list-instances a seguir lista as instâncias do serviço.

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

Resultado:

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

Para ter mais informações, consulte Listar instâncias de serviço do AWS Cloud Map no Guia do desenvolvedor do AWS Cloud Map.

Exemplo 2: listar instâncias de serviço usando o ARN de serviço

O exemplo de list-instances a seguir lista as instâncias de serviço usando um ARN de serviço em vez de um ID de serviço. É necessário especificar um ARN ao listar instâncias associadas a namespaces compartilhados com sua conta.

aws servicediscovery list-instances \ --service-id arn:aws:servicediscovery:us-west-2:123456789012:service/srv-p5zdwlg5uvvzjita

Resultado:

{ "ResourceOwner": "123456789012", "Instances": [ { "Id": "web-server-01", "Attributes": { "AWS_INSTANCE_IPV4": "203.0.113.15", "AWS_INSTANCE_PORT": "80" }, "CreatedByAccount": "123456789012" }, { "Id": "web-server-02", "Attributes": { "AWS_INSTANCE_IPV4": "203.0.113.16", "AWS_INSTANCE_PORT": "80" }, "CreatedByAccount": "123456789012" } ] }

Para ter mais informações sobre compartilhamento de namespaces entre contas, consulte Namespaces compartilhados do AWS Cloud Map e Listar instâncias de serviço do AWS Cloud Map no Guia do desenvolvedor do AWS Cloud Map.

  • Para ver detalhes da API, consulte ListInstances na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-namespaces.

AWS CLI

Exemplo 1: listar namespaces

O exemplo list-namespaces a seguir lista os namespaces.

aws servicediscovery list-namespaces

Resultado:

{ "Namespaces": [ { "Id": "ns-abcd1234xmpl5678", "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-abcd1234xmpl5678", "ResourceOwner": "123456789012", "Name": "local", "Type": "DNS_PRIVATE", "Properties": { "DnsProperties": { "HostedZoneId": "Z06752353VBUDTC32S84S", "SOA": {} }, "HttpProperties": { "HttpName": "local" } }, "CreateDate": "2023-07-17T13:37:27.872000-05:00" }, { "Id": "ns-abcd1234xmpl9012", "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-abcd1234xmpl9012", "ResourceOwner": "123456789012", "Name": "My-second-namespace", "Type": "HTTP", "Description": "My second namespace", "Properties": { "DnsProperties": { "SOA": {} }, "HttpProperties": { "HttpName": "My-second-namespace" } }, "CreateDate": "2023-11-14T10:35:47.840000-06:00" } ] }

Para ter mais informações, consulte Listar namespaces do AWS Cloud Map no Guia do desenvolvedor do AWS Cloud Map.

Exemplo 2: listar namespaces compartilhados por outras contas

O exemplo de list-namespaces a seguir lista os namespaces compartilhados com a conta do chamador por outras contas da AWS usando o filtro RESOURCE_OWNER.

aws servicediscovery list-namespaces \ --filters Name=RESOURCE_OWNER,Values=OTHER_ACCOUNTS,Condition=EQ

Resultado:

{ "Namespaces": [ { "Id": "ns-abcd1234xmpl5678", "Arn": "arn:aws:servicediscovery:us-west-2:123456789111:namespace/ns-abcd1234xmpl5678", "ResourceOwner": "123456789111", "Name": "shared-namespace", "Type": "HTTP", "Description": "Namespace shared from another account", "Properties": { "DnsProperties": { "SOA": {} }, "HttpProperties": { "HttpName": "shared-namespace" } }, "CreateDate": "2025-01-13T13:35:21.874000-06:00" } ] }

Para ter mais informações, consulte Namespaces compartilhados do AWS Cloud Map no Guia do desenvolvedor do AWS Cloud Map.

  • Para ver detalhes da API, consulte ListNamespaces na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-operations.

AWS CLI

Como listar operações que atendem aos critérios especificados

O exemplo de list-operations a seguir lista as operações que têm um status PENDING ou SUCCESS.

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

Resultado:

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

Para obter mais informações, consulte What is AWS Cloud Map? no Guia do desenvolvedor do AWS Cloud Map.

  • Para ver detalhes da API, consulte ListOperations na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-services.

AWS CLI

Exemplo 1: listar serviços

O exemplo list-services a seguir lista os serviços.

aws servicediscovery list-services

Resultado:

{ "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 } ] }

Para ter mais informações, consulte Listar serviços do AWS Cloud Map em um namespace no Guia do desenvolvedor do AWS Cloud Map.

Exemplo 2: listar serviços criados em namespaces compartilhados

O exemplo de list-services a seguir lista os serviços criados em namespaces compartilhados com a conta do chamador 123456789012 por outras contas da AWS usando o filtro RESOURCE_OWNER.

aws servicediscovery list-services \ --filters Name=RESOURCE_OWNER,Values=OTHER_ACCOUNTS,Condition=EQ

Resultado:

{ "Services": [ { "Id": "srv-abcd1234xmpl5678", "Arn": "arn:aws:servicediscovery:us-west-2:123456789111:service/srv-abcd1234xmpl5678", "ResourceOwner": "123456789111", "Name": "shared-service", "NamespaceId": "ns-abcd1234xmpl5678", "Type": "HTTP", "Description": "Service in shared namespace", "DnsConfig": {}, "CreateDate": "2025-01-13T13:35:21.874000-06:00", "CreatorRequestId": "abcd1234-5678-90ab-cdef-xmpl12345678", "CreatedByAccount": "123456789012" } ] }

Para ter mais informações, consulte Namespaces compartilhados do AWS Cloud Map e Listar serviços do AWS Cloud Map em um namespace no Guia do desenvolvedor do AWS Cloud Map.

  • Consulte detalhes da API em ListServices na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-tags-for-resource.

AWS CLI

Como listar tags associadas a um recurso especificado

O exemplo de list-tags-for-resource a seguir lista tags para o recurso especificado.

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

Resultado:

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

Para obter mais informações, consulte Tagging your AWS Cloud Map resources, no Guia do desenvolvedor do AWS Cloud Map.

O código de exemplo a seguir mostra como usar register-instance.

AWS CLI

Exemplo 1: registrar uma instância de serviço usando o ID de serviço

O exemplo register-instance a seguir registra uma instância de serviço.

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

Resultado:

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

Para confirmar que a operação foi bem-sucedida, você pode executarget-operation. Para obter mais informações, consulte get-operation.

Para ter mais informações sobre como registrar uma instância, consulte Registrar um recurso como uma instância de serviço do AWS Cloud Map no Cloud Map Developer AWS Guide.

Exemplo 2: registrar uma instância de serviço usando o ARN de serviço

O exemplo de register-instance a seguir registra uma instância de serviço usando um ARN de serviço. É necessário especificar o ARN ao registrar instâncias em serviços compartilhados com sua conta.

aws servicediscovery register-instance \ --service-id arn:aws:servicediscovery:us-west-2:123456789012:service/srv-p5zdwlg5uvvzjita \ --instance-id web-server-01 \ --attributes=AWS_INSTANCE_IPV4=203.0.113.15,AWS_INSTANCE_PORT=80

Resultado:

{ "OperationId": "gv4g5meo7ndmkqjrhpn39wk42xmpl" }

Para ter mais informações sobre compartilhamento de namespaces entre contas, consulte Namespaces compartilhados do AWS Cloud Map no Guia do desenvolvedor do AWS Cloud Map.

  • Para ver detalhes da API, consulte RegisterInstance na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar tag-resource.

AWS CLI

Como associar tags ao recurso especificado

O exemplo de tag-resource a seguir associa uma tag Department com o valor Engineering ao namespace especificado.

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

Este comando não produz saída.

Para obter mais informações, consulte Tagging your AWS Cloud Map resources, no Guia do desenvolvedor do AWS Cloud Map.

  • Consulte detalhes da API em TagResource na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar untag-resource.

AWS CLI

Como remover tags do recurso especificado

O exemplo de untag-resource a seguir remove uma tag Department do namespace especificado.

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

Este comando não produz saída.

Para obter mais informações, consulte Tagging your AWS Cloud Map resources, no Guia do desenvolvedor do AWS Cloud Map.

  • Para obter detalhes sobre a API, consulte UntagResource na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar update-http-namespace.

AWS CLI

Exemplo 1: atualizar um namespace HTTP

O exemplo de update-http-namespace a seguir atualiza a descrição do namespace HTTP especificado.

aws servicediscovery update-http-namespace \ --id ns-abcd1234xmpl5678 \ --updater-request-id abcd1234-5678-90ab-cdef-xmpl12345678 \ --namespace Description="The updated namespace description."

Resultado:

{ "OperationId": "abcd1234-5678-90ab-cdef-xmpl12345678" }

Para confirmar que a operação foi bem-sucedida, você pode executarget-operation. Para obter mais informações, consulte get-operation.

Para obter mais informações, consulte AWS Cloud Map namespaces no Guia do desenvolvedor do AWS Cloud Map.

Exemplo 2: atualizar um namespace HTTP usando o ARN

O exemplo de update-http-namespace a seguir atualiza o namespace HTTP especificado usando o respectivo ARN.

aws servicediscovery update-http-namespace \ --id arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-abcd1234xmpl5678 \ --updater-request-id abcd1234-5678-90ab-cdef-xmpl12345678 \ --namespace Description="The updated namespace description."

Resultado:

{ "OperationId": "abcd1234-5678-90ab-cdef-xmpl12345678" }

Para obter mais informações, consulte AWS Cloud Map namespaces no Guia do desenvolvedor do AWS Cloud Map.

O código de exemplo a seguir mostra como usar update-instance-custom-health-status.

AWS CLI

Exemplo 1: atualizar uma verificação de integridade personalizada

O exemplo de update-instance-custom-health-status a seguir atualiza o status da verificação de integridade personalizada do serviço especificado e da instância de serviço de exemplo para HEALTHY.

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

Este comando não produz saída.

Para obter mais informações, consulte AWS Cloud Map service health check configuration no Guia do desenvolvedor do AWS Cloud Map.

Exemplo 2: atualizar uma verificação de integridade personalizada usando um ARN de serviço

O exemplo de update-instance-custom-health-status a seguir atualiza o status da verificação de integridade personalizada usando um ARN de serviço. O ARN é necessário ao atualizar o status de integridade de instâncias associadas a namespaces compartilhados com sua conta.

aws servicediscovery update-instance-custom-health-status \ --service-id arn:aws:servicediscovery:us-west-2:123456789012:service/srv-p5zdwlg5uvvzjita \ --instance-id web-server-01 \ --status HEALTHY

Este comando não produz saída.

Para ter mais informações, consulte Configuração da verificação de integridade do serviço AWS Cloud Map e Compartilhamento de namespaces do AWS Cloud Map entre contas no Guia do desenvolvedor do AWS Cloud Map.

O código de exemplo a seguir mostra como usar update-private-dns-namespace.

AWS CLI

Exemplo 1: atualizar um namespace de DNS privado usando o ID

O exemplo de update-private-dns-namespace a seguir atualiza a descrição de um namespace de DNS privado usando o ID de namespace.

aws servicediscovery update-private-dns-namespace \ --id ns-abcd1234xmpl5678 \ --updater-request-id abcd1234-5678-90ab-cdef-xmpl12345678 \ --namespace Description="The updated namespace description."

Resultado:

{ "OperationId": "abcd1234-5678-90ab-cdef-xmpl12345678" }

Para confirmar que a operação foi bem-sucedida, você pode executarget-operation.

Para obter mais informações, consulte AWS Cloud Map namespaces no Guia do desenvolvedor do AWS Cloud Map.

Exemplo 2: atualizar um namespace de DNS privado usando o ARN

O exemplo de update-private-dns-namespace a seguir atualiza um namespace de DNS privado usando o respectivo ARN.

aws servicediscovery update-private-dns-namespace \ --id arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-abcd1234xmpl5678 \ --updater-request-id abcd1234-5678-90ab-cdef-xmpl12345678 \ --namespace Description="The updated namespace description."

Resultado:

{ "OperationId": "abcd1234-5678-90ab-cdef-xmpl12345678" }

Para obter mais informações, consulte AWS Cloud Map namespaces no Guia do desenvolvedor do AWS Cloud Map.

O código de exemplo a seguir mostra como usar update-public-dns-namespace.

AWS CLI

Exemplo 1: atualizar um namespace de DNS público usando o ID

O exemplo de update-public-dns-namespace a seguir atualiza a descrição de um namespace de DNS público usando o respectivo ID.

aws servicediscovery update-public-dns-namespace \ --id ns-abcd1234xmpl5678 \ --updater-request-id abcd1234-5678-90ab-cdef-xmpl12345678 \ --namespace Description="The updated namespace description."

Resultado:

{ "OperationId": "abcd1234-5678-90ab-cdef-xmpl12345678" }

Para confirmar que a operação foi bem-sucedida, você pode executarget-operation.

Para obter mais informações, consulte AWS Cloud Map namespaces no Guia do desenvolvedor do AWS Cloud Map.

Exemplo 2: atualizar um namespace de DNS público usando o ARN

O exemplo de update-public-dns-namespace a seguir atualiza um namespace de DNS público usando o respectivo ARN.

aws servicediscovery update-public-dns-namespace \ --id arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-abcd1234xmpl5678 \ --updater-request-id abcd1234-5678-90ab-cdef-xmpl12345678 \ --namespace Description="The updated namespace description."

Resultado:

{ "OperationId": "abcd1234-5678-90ab-cdef-xmpl12345678" }

Para obter mais informações, consulte AWS Cloud Map namespaces no Guia do desenvolvedor do AWS Cloud Map.

O código de exemplo a seguir mostra como usar update-service-attributes.

AWS CLI

Exemplo 1: atualizar um serviço para adicionar um atributo

O exemplo de update-service-attributes a seguir atualiza o serviço especificado para adicionar um atributo de serviço com uma chave Port e um valor 80.

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

Este comando não produz saída.

Para obter mais informações, consulte AWS Cloud Map services no Guia do desenvolvedor do AWS Cloud Map.

Exemplo 2: atualizar atributos de um serviço usando o ARN

O exemplo de update-service-attributes a seguir atualiza um serviço usando o respectivo ARN para adicionar um atributo de serviço. É necessário especificar o ARN para adicionar atributos aos serviços criados em namespaces compartilhados com sua conta.

aws servicediscovery update-service-attributes \ --service-id arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678 \ --attributes Port=80

Este comando não produz saída.

Para ter mais informações, consulte Serviços do AWS Cloud Map e Namespaces compartilhados do AWS Cloud Map no Guia do desenvolvedor do AWS.

O código de exemplo a seguir mostra como usar update-service.

AWS CLI

Exemplo 1: atualizar um serviço

O exemplo de update-service a seguir atualiza um serviço para atualizar as configurações HealthCheckConfig e DnsConfig.

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

Resultado:

{ "OperationId": "abcd1234-5678-90ab-cdef-xmpl12345678" }

Para confirmar que a operação foi bem-sucedida, você pode executarget-operation.

Para obter mais informações sobre como atualizar um serviço, consulte Updating an AWS Cloud Map service no Guia do desenvolvedor do AWS Cloud Map.

Exemplo 2: atualizar um serviço usando o ARN

O exemplo de update-service a seguir atualiza um serviço usando o respectivo ARN. É necessário especificar o ARN para serviços criados em namespaces compartilhados com sua conta.

aws servicediscovery update-service \ --id arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678 \ --service "DnsConfig={DnsRecords=[{Type=A,TTL=60}]},HealthCheckConfig={Type=HTTP,ResourcePath=/,FailureThreshold=2}"

Resultado:

{ "OperationId": "abcd1234-5678-90ab-cdef-xmpl12345678" }

Para ter mais informações sobre como atualizar um serviço, consulte Atualizar um serviço do AWS Cloud Map e Namespaces compartilhados do AWS Cloud Map no Guia do desenvolvedor do AWS Cloud Map.

  • Consulte detalhes da API em UpdateService na Referência de comandos da AWS CLI.