Help Center/ ImageSearch/ API Reference/ Appendix/ Obtaining a Project ID and Name
Updated on 2023-12-13 GMT+08:00

Obtaining a Project ID and Name

Scenarios

A project ID or name is required for some requests when an API is called. Therefore, obtain the project ID and name before calling the API. Use either of the following methods:

Obtaining a Project ID from the Console

  1. Log in to the management console.
  2. Hover the cursor over your username in the upper right corner and click My Credentials from the drop-down list.
  3. On the My Credentials page, view the username and account name and view projects in the project list.
    Figure 1 Viewing project ID

    If there are multiple projects in one region, expand Region and view subproject IDs in the Project ID column.

Obtaining a Project ID by Calling an API

A project ID can be obtained by calling a specific API. For details, see Querying Project Information Based on the Specified Criteria.

The API for obtaining a project ID is GET https://{iam-endpoint}/v3/projects/. You can obtain the value from Regions and Endpoints.

The following is an example response. For example, if Image Search is deployed in the ap-southeast-1 region, the value of name in the response body is ap-southeast-1. The value of id in projects is the project ID.

{
	"projects": [{
		"domain_id": "65382450e8f64ac0870cd180d14e684b",
		"is_domain": false,
		"parent_id": "65382450e8f64ac0870cd180d14e684b",
		"name": "ap-southeast-1",
		"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"
	}
}