ListInvitations - 查询全部加入企业组织邀请--企业组织-火山引擎

文档中心

立即注册

导航

ListInvitations - 查询全部加入企业组织邀请

最近更新时间：2024.01.11 17:42:35首次发布时间：2024.01.11 17:42:35

查询全部加入企业组织邀请

API Explorer

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

去调试

请求参数

名称	类型	是否必填	示例值	描述
Action	String	是	ListInvitations	要执行的操作，取值：ListInvitations
Version	String	是	2022-01-01	API的版本，取值：2022-01-01
Offset	Integer	否		分页，第一页为1
Limit	Integer	否		分页大小，默认10
OrgUnitId	String	否		组织单元Id
Search	String	否		按显示名或账号Id模糊查询
OrderStr	String	否		排序字段，"created_time"，"updated_time"，默认created_time
OrderBy	String	否		排序顺序，1.降序 2.升序，默认降序

响应数据

名称	类型	描述
InvitationList	Array of AccountInvitationAndOUName	账号邀请详情
Offset	Integer	分页，第一页为1
Limit	Integer	分页大小，默认10
Total	Integer	总数

示例

请求

GET /?Action= ListInvitations&Version=2022-01-01 
--header 'Content-Type: application/json' \
-d '{"OrgId": 0011223344556677889","Limit":10,"Offset":1"}'

响应

{
    "ResponseMetadata": {
        "RequestId": "20231013180104B146DF6BF392EF63336B",
        "Action": "ListInvitations",
        "Version": "2022-01-01",
        "Service": "organization",
        "Region": "cn-north-1"
    },
    "Result": {
        "Limit": 10,
        "Offset": 1,
        "Total": 1,
        "InvitationList": [
            {
                "ID": "7181799962303316012",
                "CreatedTime": "2022-12-27T20:19:27+08:00",
                "UpdatedTime": "2022-12-27T20:21:18+08:00",
                "Owner": "2100245176",
                "OrgID": "7167316755275595820",
                "OrgUnitID": "7167316755275661356",
                "AccountID": "2100245625",
                "AccountName": "name",
                "LinkID": "20221227435661426439",
                "Description": "",
                "ShowName": "name",
                "AllowExit": 1,
                "Status": 2,
                "RejectReason": "",
                "OrgUnitName": "Root",
                "ExTime": "2023-01-11 20:19:27"
            }
        ]
    }
}

错误码

下表提供了该接口业务逻辑相关的错误码。公共错误码请参见公共错误码。

HttpCode	错误码	错误信息	描述
500	InternalError	Unknown internal error: %v	未知错误，根据错误信息判断详情
400	PermissionError	No permission to perform action[%s] on resource %s	无权限，没有对该资源进行该操作的权限
400	InvalidParam	The parameter %v[%v] is invalid.	参数不合法
404	RecordNotExists	record %s not exists	记录不存在