Help Center/ GaussDB/ API Reference/ Appendix/ Obtaining a Project ID
Updated on 2024-08-20 GMT+08:00

Obtaining a Project ID

Scenarios

When calling APIs, you need to specify the project ID in some URLs. To do so, you need to obtain the project ID using either of the following methods:

Obtaining the Project ID by Calling an API

You can obtain the project ID by calling the API used to query project information based on the specified criteria.

The API used to obtain a project ID is GET https://{Endpoint}/v3/projects. {Endpoint} is the IAM endpoint and can be obtained from Regions and Endpoints. For details about API authentication, see Authentication.

The following is an example response. id indicates the project ID, and name indicates the project name.

{
    "projects": [
        {
            "domain_id": "65382450e8f64ac0870cd180d14e684b",
            "is_domain": false,
            "parent_id": "65382450e8f64ac0870cd180d14e684b",
            "name": "project_name",
            "description": "",
            "links": {
                "next": null,
                "previous": null,
                "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99"
            },
            "id": "a4a5d4098fb4474fa22cd05f897d6b99",
            "enabled": true
        }
    ],
    "links": {
        "next": null,
        "previous": null,
        "self": "https://www.example.com/v3/projects"
    }
}

Obtaining a Project ID from the Console

  1. Register yourself on the management console and log in to it.
  2. Hover the mouse over the username in the upper right corner and select My Credentials from the drop-down list.

    On the API Credentials page, view the project ID and name in the project list.

    Figure 1 Viewing project IDs