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

文档中心

立即注册

导航

ListProjects - 获取项目列表

最近更新时间：2025.06.23 14:09:23首次发布时间：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（不获取）、1（获取），传入其他值会抛出异常，不传值默认0
Limit	Integer	否	10	分页大小。传入的值必须在(0,1000]区间
Offset	Integer	否	0	页码偏移

返回参数

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

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

请求示例

GET /?Action=ListProjects&Version=2021-08-01&Query=project&WithParentProject=0&Limit=10&Offset=0 HTTP/1.1
Host: http://iam.volcengineapi.com/?Action=DetachPolicyInProject&Version=2021-08-01
X-Date: 20250618T133259Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250618/cn-beijing/iam/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20250618213302183107229079F624B8",
    "Action": "ListProjects",
    "Version": "2021-08-01",
    "Service": "iam",
    "Region": "cn-beijing"
  },
  "Result": {
    "Limit": 10,
    "Offset": 0,
    "Total": 100,
    "Projects": [
      {
        "ProjectName": "GefKTkAd",
        "ParentProjectName": "xrUUqRAaYmw",
        "Path": "98bYOQcJk",
        "DisplayName": "6G",
        "AccountID": 231,
        "Description": "qb9yL",
        "CreateDate": "qLMFeQVZf",
        "UpdateDate": "VXz0",
        "Status": "ND",
        "HasPermission": true
      }
    ]
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
500	InternalError	The request processing has failed because of an internal error.	服务内部系统错误。往往是由服务内部组件异常、网络异常或服务自身bug导致，请及时联系相关管理员进行排查确认