文档首页> 统一身份认证服务 IAM> API参考> API> 项目管理> 修改项目信息
更新时间：2024-04-19 GMT+08:00
查看PDF

修改项目信息

功能介绍

该接口可以用于管理员修改项目信息。

该接口可以使用全局区域的Endpoint和其他区域的Endpoint调用。IAM的Endpoint请参见：地区和终端节点。

URI

PATCH /v3/projects/{project_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

待修改的项目ID，获取方式请参见：获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

该字段内容填为“application/json;charset=utf8”。

X-Auth-Token

是

String

访问令牌，承载用户的身份、权限等信息。

token所需权限请参见授权项。
表3 请求Body参数

参数

是否必选

参数类型

描述

project

是

Object

需要修改的项目信息。
表4 project

参数

是否必选

参数类型

描述

name

否

String

项目名称，必须以存在的"区域ID_"开头，长度小于等于64。项目所属区域不能改变，即原项目名为“ap-southeast-1_IAMProject”时，新项目名只能以“ap-southeast-1_”开头。“name”与"description"至少填写一个。

description

否

String

项目描述，长度小于等于255字符。“name”与"description"至少填写一个。

响应参数

表5 响应Body参数

参数

参数类型

描述

project

Object

项目信息。
表6 project

参数

参数类型

描述

is_domain

Boolean

false.

description

String

项目描述信息。

extra

Object

项目的其他信息。

links

Object

项目的资源链接。

enabled

Boolean

项目是否可用。

id

String

项目ID。

parent_id

String

区域对应的项目ID，例如区域“中国-香港”区域对应的项目ID为：04dd42abe48026ad2fa3c01ad7fa.....。

domain_id

String

项目所属账号ID。

name

String

项目名称。
表7 project.links

参数

参数类型

描述

self

String

资源链接地址。

请求示例

修改项目的名称为“ap-southeast-1_IAMNewProject”，描述修改为“IAMDescription”。

PATCH https://iam.myhuaweicloud.com/v3/projects/{project_id}
{
    "project": {
        "name": "ap-southeast-1_IAMNewProject",
        "description": "IAMDescription"
    }
}

响应示例

状态码为 200 时:

请求成功。

{
    "project": {
        "is_domain": false,
        "description": "IAMDescription",
        "links": {
            "self": "https://iam.myhuaweicloud.com/v3/projects/07707ab14980265e2f5fc003a021bbc3"
        },
        "extra": {},
        "enabled": true,
        "id": "07707ab14980265e2f5fc003a021bbc3",
        "parent_id": "aa2d97d7e62c4b7da3ffdfc11551f878",
        "domain_id": "d78cbac186b744899480f25bd...",
        "name": "ap-southeast-1_IAMNewProject"
    }
}

返回值

返回值

描述

200

请求成功。

400

参数无效。

401

认证失败。

403

没有操作权限。

409

资源冲突。

错误码

无

父主题： 项目管理