Updated on 2024-07-30 GMT+08:00

Changing Project Status

Function

This API is provided for the administrator to change the status of a specified project. The project status can be normal or suspended.

The API can be called using both the global endpoint and region-specific endpoints. For IAM endpoints, see Regions and Endpoints.

Debugging

You can debug this API in API Explorer.

URI

PUT /v3-ext/projects/{project_id}

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining Account, IAM User, Group, Project, Region, and Agency Information.

Request Parameters

Table 2 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 3 Parameters in the request body

Parameter

Mandatory

Type

Description

project

Yes

Object

Project information.

Table 4 project

Parameter

Mandatory

Type

Description

status

Yes

String

Project status. The value can be suspended or normal.

  • suspended: Freeze the project.
  • normal: Unfreeze the project.

Options:

  • suspended
  • normal

Response Parameters

None

Example Request

Request for changing the project status to suspended

PUT https://iam.myhuaweicloud.com/v3-ext/projects/{project_id}
{
    "project": {
        "status": "suspended"
    }
}

Example Response

None

Status Codes

Status Code

Description

204

Setting successful.

400

Invalid parameters.

401

Authentication failed.

403

Access denied.

404

The requested resource cannot be found.

500

Internal server error.

503

Service unavailable.

Error Codes

None