Help Center/ ModelArts/ API Reference/ Common Parameters/ Obtaining a Project ID and Name
Updated on 2024-05-30 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 and Name from the Console

To do so, perform the following operations:

  1. Sign up and log in to the ModelArts console.
  2. In the upper right corner of the page, click the username and choose My Credentials from the drop-down list. The My Credentials page is displayed.

    If you have logged in to the official HUAWEI CLOUD website but not the console, click your username in the upper right corner and choose My Account from the drop-down list. On the Basic Information page, click Manage following Security Credentials. Then, the My Credentials page is displayed.

  3. On the API Credentials page, view the project ID and name in the Projects area.
    Figure 1 Viewing the project ID

    If there are multiple projects, unfold the target region and obtain the project ID from 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. To obtain {iam-endpoint}, see Request URIRegions and Endpoints.

The following is an example response. For example, if ModelArts 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"
	}
}