查询指定条件下的项目列表 - KeystoneListProjects

功能介绍

该接口可以用于查询指定条件下的项目列表。

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

调试

您可以在API Explorer中调试该接口。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

GET /v3/projects

表1 Query参数
参数	是否必选	参数类型	描述
domain_id	否	String	项目所属账号ID，获取方式请参见：获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。
enabled	否	Boolean	项目是否启用。
is_domain	否	Boolean	该字段无需填写。
name	否	String	项目名称，获取方式请参见：获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。
page	否	Integer	分页查询时数据的页数，查询值最小为1。需要与per_page同时存在。
parent_id	否	String	如果查询自己创建的项目，则此处应填为所属区域的项目ID。如果查询的是系统内置项目，如cn-north-1，则此处应填为账号ID。获取项目ID和账号ID，请参见：获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。
per_page	否	Integer	分页查询时每页的数据个数，取值范围为[1,5000]。需要与page同时存在。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
Content-Type	是	String	该字段内容填为“application/json;charset=utf8”。
X-Auth-Token	是	String	访问令牌，承载用户的身份、权限等信息。 token所需权限请参见授权项。

响应参数

表3 响应Body参数
参数	参数类型	描述
links	Object	资源链接信息。
projects	Array of objects	项目信息列表。

表4 links
参数	参数类型	描述
self	String	资源链接地址。
previous	String	前一邻接资源链接地址，不存在时为null。
next	String	后一邻接资源链接地址，不存在时为null。

表5 projects
参数	参数类型	描述
is_domain	Boolean	false.
description	String	项目描述信息。
links	Object	项目的资源链接。
enabled	Boolean	项目是否可用。
id	String	项目ID。
parent_id	String	如果查询自己创建的项目，则此处返回所属区域的项目ID。如果查询的是系统内置项目，如cn-north-1，则此处返回账号ID。
domain_id	String	项目所属账号ID。
name	String	项目名称。如cn-north-1、MOS等，其中MOS为OBS内置项目。

表6 projects.links
参数	参数类型	描述
self	String	资源链接地址。
previous	String	前一邻接资源链接地址，不存在时为null。
next	String	后一邻接资源链接地址，不存在时为null。

请求示例

查询指定条件下的项目列表。

GET https://iam.myhuaweicloud.com/v3/projects

响应示例

状态码为 200 时:

请求成功。

{
    "projects": [
        {
            "domain_id": "d78cbac186b744899480f25bd02...",
            "is_domain": false,
            "parent_id": "d78cbac186b744899480f25bd022...",
            "name": "cn-north-1",
            "description": "",
            "links": {
                "next": null,
                "previous": null,
                "self": "https://iam.myhuaweicloud.com/v3/projects/06f1c15e6f0010672f86c003006c5f17"
            },
            "id": "06f1c15e6f0010672f86c00300...",
            "enabled": true
        },
        {
            "domain_id": "d78cbac186b744899480f25bd...",
            "is_domain": false,
            "parent_id": "d78cbac186b744899480f25bd0...",
            "name": "cn-north-1",
            "description": "",
            "links": {
                "next": null,
                "previous": null,
                "self": "https://iam.myhuaweicloud.com/v3/projects/065a7c66da0010992ff7c0031e5a..."
            },
            "id": "065a7c66da0010992ff7c0031e5a...",
            "enabled": true
        }
    ],
    "links": {
        "next": null,
        "previous": null,
        "self": "https://iam.myhuaweicloud.com/v3/projects"
    }
}

返回值

返回值	描述
200	请求成功。
400	参数无效。
401	认证失败。
403	没有操作权限。
404	未找到相应的资源。
500	内部服务错误。
503	服务不可用。