Help Center/ Identity and Access Management/ API Reference/ API/ Project Management/ Creating a Project
Updated on 2023-09-14 GMT+08:00
View PDF

Creating a Project

Function

This API is provided for the administrator to create a project.

The API can be called using both the global endpoint and region-specific endpoints.

URI

POST /v3/projects

Request Parameters

Table 1 Parameters in the request header

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Fill application/json;charset=utf8 in this field.

X-Auth-Token

Yes

String

Access token issued to a user to bear its identity and permissions.

For details about the permissions required by the token, see Actions.
Table 2 Parameters in the request body

Parameter

Mandatory

Type

Description

project

Yes

Object

Project information.
Table 3 project

Parameter

Mandatory

Type

Description

name

Yes

String

Project name, which must start with ID of an existing region_ and can contain less than or equal to 64 characters. For example, the ID of the EU-Dublin region is eu-west-101. You can create a subproject named eu-west-101_IAMProject in this region.

parent_id

Yes

String

Project ID of the corresponding region. For example, the project ID of the EU-Dublin region is 04dd42abe48026ad2fa3c01ad7fa...... For details about how to obtain the project ID, see Obtaining Account, IAM User, Group, Project, Region, and Agency Information.

domain_id

No

String

ID of the account to which the project belongs.

description

No

String

Project description, which can contain a maximum of 255 characters.

Response Parameters

Table 4 Parameters in the response body

Parameter

Type

Description

project

Object

Project information.
Table 5 project

Parameter

Type

Description

is_domain

Boolean

The value is false.

description

String

Description of the project.

links

Object

Project resource link.

enabled

Boolean

Enabling status of the project.

id

String

Project ID.

parent_id

String

Project ID of the corresponding region. For example, the project ID of the EU-Dublin region is 04dd42abe48026ad2fa3c01ad7fa......

domain_id

String

Account ID of the project.

name

String

Project name.
Table 6 project.links

Parameter

Type

Description

self

String

Resource link.

Example Request

Request for creating a project named eu-west-101_IAMProject under the account whose ID is d78cbac186b744899480f25bd0... in the EU-Dublin region

POST https://iam.myhuaweicloud.eu/v3/projects
{
    "project": {
        "name": "eu-west-101_IAMProject",
        "parent_id": "aa2d97d7e62c4b7da3ffdfc11551f878",
        "domain_id": "d78cbac186b744899480f25bd0...",
        "description": "IAMDescription"
    }
}

Example Response

Status code: 201

The project is created successfully.

{
    "project": {
        "is_domain": false,
        "description": "IAMDescription",
        "links": {
            "self": "https://iam.myhuaweicloud.eu/v3/projects/07707ab14980265e2f5fc003a021bbc3"
        },
        "enabled": true,
        "id": "07707ab14980265e2f5fc003a021bbc3",
        "parent_id": "aa2d97d7e62c4b7da3ffdfc11551f878",
        "domain_id": "d78cbac186b744899480f25bd02...",
        "name": "eu-west-101_IAMProject"
    }
}

Status Codes

Status Code

Description

201

The project is created successfully.

400

Invalid parameters.

401

Authentication failed.

403

Access denied.

409

A resource conflict occurs.

Error Codes

None

Parent topic: Project Management