ListProjects - 获取项目列表--资源管理-火山引擎

文档中心

立即注册

导航

ListProjects - 获取项目列表

最近更新时间：2024.01.22 21:34:33首次发布时间：2023.08.24 21:41:32

获取项目列表

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	ListProjects	要执行的操作，取值：ListProjects
Version	String	是	2021-08-01	API的版本，取值：2021-08-01
Query	String	否	project	对项目名进行模糊查询
WithParentProject	Integer	否	1	是否获取父集项目，默认为0，取值： 0：获取权限作用域为对应项目及其所有子项目 1：获取权限作用域对应项目及其所有子项目和父级项目（父级项目部分信息隐藏）
Limit	Integer	否	10	分页大小，默认10
Offset	Integer	否	0	页码偏移，默认0

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数	类型	示例值	描述
Limit	Integer	10	分页大小
Offset	Integer	0	偏移大小
Total	Integer	100	总数
Projects	Array of Project	{ "AccountID": 2000000000, "ProjectName": "project", "ParentProjectName": "", "Path": "/project/", "DisplayName": "", "Description": "", "CreateDate": "20210615T101537Z", "UpdateDate": "20211231T075055Z", "Status": "active", "HasPermission": true }	项目信息

请求示例

http://iam.volcengineapi.com/?Action=ListProjects
&Version=2021-08-01
&Limit=1
&Offset=1
&WithParentProject=1

返回示例

{
"ResponseMetadata": {
        "RequestId": "20230131190019DAD5E1C202FD43BEDE74",
        "Action": "ListProjects",
        "Version": "2021-08-01",
        "Service": "iam",
        "Region": "cn-north-1"
    },
    "Result": {
        "Projects": [
            {
                "AccountID": 2100245449,
                "ProjectName": "project-name",
                "ParentProjectName": "",
                "Path": "/project-name/",
                "DisplayName": "display-name",
                "Description": "demo",
                "CreateDate": "20221228T085849Z",
                "UpdateDate": "20230105T064809Z",
                "Status": "active",
                "HasPermission": true
            }
        ],
        "Limit": 1,
        "Offset": 1,
        "Total": 5
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。