Skip to content

Latest commit

 

History

History
91 lines (62 loc) · 3.78 KB

retrieve-instance-id.md

File metadata and controls

91 lines (62 loc) · 3.78 KB
copyright lastupdated keywords subcollection
years
2020, 2024
2024-10-25
instance ID, instance GUID, get instance ID, get instance GUID, instance ID API, instance ID CLI
dns-svcs

{{site.data.keyword.attribute-definition-list}}

Retrieving your instance ID

{: #retrieve-instance-ID}

Retrieve your instance ID by using the UI, CLI, or API. {: shortdesc}

You can target an individual {{site.data.keyword.dns_full}} service instance for operations by including its unique identifier, or instance ID, in API requests to the service.

Retrieving your instance ID in the UI

{: #view-instance-ID} {: ui}

You can view the instance ID that is associated with your {{site.data.keyword.dns_short}} service instance by navigating to your {{site.data.keyword.cloud_notm}} resource list.

  1. Log in to the {{site.data.keyword.cloud_notm}} console{: external}.
  2. Go to Menu > Resource List, and then click Services to browse a list of your cloud services.
  3. Click the table row that describes your {{site.data.keyword.dns_short}} service instance.
  4. From the service details view, copy the GUID value. This GUID value represents the instance ID that uniquely identifies your {{site.data.keyword.dns_short}} service instance.

Retrieving your instance ID from the CLI

{: #retrieve-cli} {: cli}

You can also retrieve the instance ID for your service instance by using the {{site.data.keyword.cloud_notm}} CLI{: external}.

  1. Log in to {{site.data.keyword.cloud_notm}} with the {{site.data.keyword.cloud_notm}} CLI{: external}.

    ibmcloud login

    {: pre}

    If the login fails, run the ibmcloud login --sso command to try again. The --sso parameter is required when you log in with a federated ID. If this option is used, go to the link listed in the CLI output to generate a one-time passcode. {: note}

  2. Select the account, region, and resource group that contain your provisioned instance of {{site.data.keyword.dns_short}}.

  3. Retrieve the Cloud Resource Name (CRN) that uniquely identifies your {{site.data.keyword.dns_short}} service instance.

    ibmcloud resource service-instance <instance_name> --id

    {: pre}

    Replace <instance_name> with the unique alias that you assigned to your {{site.data.keyword.dns_short}} service instance. The following truncated example shows the CLI output.

    crn:v1:bluemix:public:kms:us-south:a/f047b55a3362ac06afad8a3f2f5586ea:42454b3b-5b06-407b-a4b3-34d9ef323901:: 42454b3b-5b06-407b-a4b3-34d9ef323901

    {: screen}

    The 42454b3b-5b06-407b-a4b3-34d9ef323901 value is an example instance ID.

Retrieving your instance ID with the API

{: #retrieve-api} {: api}

You might want to retrieve the instance ID programmatically to help you build and connect your application. You can call the {{site.data.keyword.cloud_notm}} Resource Controller API{: external}, and then pipe the JSON output to jq to extract this value.

  1. Retrieve an {{site.data.keyword.cloud_notm}} IAM access token.

  2. Call the Resource Controller API{: external} to retrieve your instance ID.

    curl -X GET \
  'https://resource-controller.cloud.ibm.com/v2/resource_instances' \
  -H 'authorization: Bearer <IAM_token>' | jq -r '.resources[] | select(.name | contains("<instance_name>")) | .guid'

    {: codeblock}

    Replace <instance_name> with the unique alias that you assigned to your {{site.data.keyword.dns_short}} service instance. The following output shows an example instance ID:

    42454b3b-5b06-407b-a4b3-34d9ef323901

    {: screen}