/ 统一身份认证服务 iam/ / / / 查询指定条件下的项目列表
更新时间：2024-08-10 gmt 08:00

查询指定条件下的项目列表-九游平台

功能介绍

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

该接口可以使用全局区域的endpoint和其他区域的endpoint调用。iam的endpoint请参见：。

调试

您可以在中调试该接口。

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

服务不可用。

错误码

无

父主题：

相关文档

网站地图