ListProjectIdentities - 获取项目身份实体列表--资源管理-火山引擎

文档中心

立即注册

导航

ListProjectIdentities - 获取项目身份实体列表

最近更新时间：2025.06.23 14:09:23首次发布时间：2023.08.24 21:41:32

获取项目身份实体列表

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	ListProjectIdentities	要执行的操作，取值：ListProjectIdentities。
Version	String	是	2021-08-01	API的版本，取值：2021-08-01。
Limit	Integer	否	10	分页大小。传入的值必须在(0,1000]区间
Offset	Integer	否	0	页码偏移量
IdentityType	String	是	User	身份类型，可传值：User（子用户）、Role（角色）、UserGroup（用户组）。传入其他值会抛出异常
Query	String	否	username	可对用户/角色/用户组的展示名称进行模糊查询
ProjectName	String	是	project	项目名称

返回参数

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

参数	类型	示例值	描述
Limit	Integer	10	页面大小
Offset	Integer	0	页码偏移量
Total	Integer	100	总数
ProjectUserGroups	Array of Object	[{ "UserGroupName": "ServiceRoleForECS", "DisplayName": "ECS服务关联角色", "Description": "ECS服务关联角色", "Policy": [ { "PolicyTrn": "trn:iam::0:policy/BillFullAccess", "PolicyName": "BillFullAccess", "PolicyType": "System", "Description": "账户内财务相关的内容管理权限（例如账单、订单等）\t", "AttachDate": "20230810T073620Z", "IsServiceRolePolicy": 0 } ], "UpdateDate": "20230810T073620Z" }]	项目相关的用户组列表
ProjectUsers	Array of Object	[ { "UserName": "test", "DisplayName": "", "Description": "", "Policy": [ { "PolicyTrn": "trn:iam::0:policy/BillFullAccess", "PolicyName": "BillFullAccess", "PolicyType": "System", "Description": "账户内财务相关的内容管理权限（例如账单、订单等）", "AttachDate": "20230810T073747Z", "IsServiceRolePolicy": 0 } ], "UpdateDate": "20230810T073747Z" } ]	项目用户信息列表
ProjectRoles	Array of Object	[ { "RoleName": "adminrole", "DisplayName": "pln", "Description": "", "Policy": [ { "PolicyTrn": "trn:iam::0:policy/AdministratorAccess", "PolicyName": "AdministratorAccess", "PolicyType": "System", "Description": "帐户服务和资源的管理权限", "AttachDate": "20230707T040408Z", "IsServiceRolePolicy": 0 } ], "UpdateDate": "20230707T040408Z" } ]	项目角色列表

请求示例

GET /?Action=ListProjectIdentities&Version=2021-08-01&IdentityType=User&ProjectName=project HTTP/1.1
Host: http://iam.volcengineapi.com/?Action=DetachPolicyInProject&Version=2021-08-01
X-Date: 20250618T111842Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250618/cn-beijing/iam/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202506181918532441940240836C4FB2",
        "Action": "ListProjectIdentities",
        "Version": "2021-08-01",
        "Service": "iam",
        "Region": "cn-beijing"
    },
    "Result": {
        "Limit": 10,
        "Offset": 0,
        "Total": 100,
        "ProjectUserGroups": [
            {
                "DisplayName": "cxG4XTU",
                "UpdateDate": "VB9jtNlTGqL",
                "UserGroupName": "pcH",
                "Description": "ZRW1Xzw",
                "Policy": [
                    {
                        "PolicyTrn": "trn:iam::0:policy/BillFullAccess",
                        "PolicyType": "System",
                        "AttachDate": "20230810T073747Z",
                        "PolicyName": "BillFullAccess",
                        "IsServiceRolePolicy": 0,
                        "Description": "账户内财务相关的内容管理权限（例如账单、订单等）"
                    }
                ]
            }
        ],
        "ProjectUsers": [
            {
                "UserName": "d7M8HcwocEB",
                "DisplayName": "FhGD48ZM",
                "Description": "hs3d8IR",
                "UpdateDate": "M8",
                "Policy": [
                    {
                        "PolicyTrn": "trn:iam::0:policy/BillFullAccess",
                        "PolicyType": "System",
                        "AttachDate": "20230810T073747Z",
                        "PolicyName": "BillFullAccess",
                        "IsServiceRolePolicy": 0,
                        "Description": "账户内财务相关的内容管理权限（例如账单、订单等）"
                    }
                ]
            }
        ],
        "ProjectRoles": [
            {
                "RoleName": "adminrole",
                "DisplayName": "pln",
                "Description": "",
                "Policy": [
                    {
                        "PolicyTrn": "trn:iam::0:policy/AdministratorAccess",
                        "PolicyName": "AdministratorAccess",
                        "PolicyType": "System",
                        "Description": "帐户服务和资源的管理权限",
                        "AttachDate": "20230707T040408Z",
                        "IsServiceRolePolicy": 0
                    }
                ],
                "UpdateDate": "20230707T040408Z"
            }
        ]
    }
}

错误码

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

状态码	错误码	错误信息	说明
404	EntityNotFound	The '%s' of '%v' is not found.	找不到对应的实体。请确认传入的实体参数是否真实存在
500	InternalError	The request processing has failed because of an internal error.	服务内部系统错误。往往是由服务内部组件异常、网络异常或服务自身bug导致，请及时联系相关管理员进行排查确认