API文档中心

租户端基础平台基础平台数据结构

数据结构

最近更新时间: 2026-04-09 00:08:01

AttachedUserPolicy

用户关联的策略详情

被如下接口引用：ListAttachedUserAllPolicies

名称	必选	允许NULL	类型	描述
PolicyId	否	否	Uint64	策略ID 示例值： 1000
PolicyName	否	否	String	策略名示例值： policygen-20141112201913
Description	否	否	String	策略描述示例值： adesc
AddTime	否	否	String	创建时间示例值： 2014-08-03 12:00:00
StrategyType	否	否	Uint64	策略类型(1表示自定义策略，2表示预设策略) 示例值： 1
CreateMode	否	否	Uint64	创建模式(1表示按产品或项目权限创建的策略，其他表示策略语法创建的策略) 示例值： 1
Groups	否	是	Array of AttachedUserPolicyGroupInfo	随组关联信息示例值：查看

ServiceItem

服务

被如下接口引用：GetServiceList

名称	必选	允许NULL	类型	描述
AddTime	否	否	Datetime	创建时间示例值： 2014-08-03 12:00:00
ArnDocument	否	否	String	ArnDocument 示例值： https://www.example.com/document/product/378/8222965
ColConf	否	是	String	ColConf 示例值： ColConf
DefAddr	否	是	String	DefAddr 示例值： DefAddr
DefaultStrategyList	否	否	String	默认策略示例值： DefaultStrategyList
IsAllowDefProj	否	否	String	IsAllowDefProj 示例值： 1
IsDisProject	否	否	String	IsDisProject 示例值： 1
IsDisZone	否	否	String	IsDisZone 示例值： 1
IsSeen	否	否	String	是否可见示例值： 1
Online	否	否	String	Online 示例值： Online
QueryAddr	否	否	String	QueryAddr 示例值： cvm
QueryInterface	否	否	String	QueryInterface 示例值： cvm
ServiceEnName	否	否	String	服务英文名示例值： cvm
ServiceName	否	否	String	服务名示例值： cvm
ServiceType	否	否	String	服务类型示例值： cvm
SynInterface	否	否	String	SynInterface 示例值： cvm
UpdateTime	否	否	Datetime	变更时间示例值： 2014-08-03 12:00:00
Weight	否	否	String	Weight 示例值： 1
WhiteKey	否	否	String	WhiteKey 示例值： white1
Writter	否	否	String	创建人示例值： admin
ResourceTypeList	否	否	Array of ResourceTypeItem	资源类型数组示例值：查看
Type	否	否	String	类型示例值： cvm

UserList

子账号列表

被如下接口引用：ListUsersForPolicy

名称	必选	允许NULL	类型	描述
Name	是	否	String	子账号名称示例值： admin
SubAccountUin	是	否	String	子账号uin 示例值： 1000

OwnerAccountAttribute

主账户属性

被如下接口引用：UpdateOwnerAccount

名称	必选	允许NULL	类型	描述
Remark	否	否	String	属性示例值： remark

PasswordRules

密码规则

被如下接口引用：GetPasswordRules、UpdatePasswordRules

名称	必选	允许NULL	类型	描述
MinimumLength	是	否	Int64	最小密码长度示例值： 10
MustContain	是	否	String	最少包含示例值： Aa!
ForcePasswordChange	是	否	Int64	密码有效期示例值： 0
ReusePasswordLimit	是	否	Int64	密码重复次数示例值： 2
RetryPasswordLimit	否	否	Int64	登陆最大密码失败次数示例值： 2
OnlyAdminCanResetPassword	否	否	Int64	是否只有admin可以重置密码示例值： 0
MustNotContainUsername	否	否	Int64	必须不包含用户名示例值： 0

SubAccountFilter

带过滤条件的子帐号信息

被如下接口引用：GetGroupList、GetGroupsSubAccount、GetSubsGroup、ListGroups、ListGroupsForConsole、ListMaskedSubAccounts、ListSubAccounts

名称	必选	允许NULL	类型	描述
Uid	是	是	Uint64	子用户Uid 示例值： 1258042
Uin	是	是	Uint64	用户Uin 示例值： 130000000001
Name	是	是	String	用户Name 示例值： username
Remark	是	是	String	备注示例值： remark
CanLogin	是	是	Uint64	是都允许登录示例值： 1
PhoneNum	是	是	String	电话号码示例值： 11111111111
CountryCode	是	是	String	区号示例值： 86
PhoneFlag	是	是	Int64	电话号码是否验证示例值： 1
Email	是	是	String	邮箱示例值： mail@mail.com
EmailFlag	是	是	Int64	邮箱是否验证示例值： 1
UserType	是	是	Int64	用户类型示例值： 0
CreateTime	是	是	String	创建时间示例值： 2019-04-29 21:18:28
IsReceiverOwner	是	是	Int64	是否消息接收人示例值： 1
SystemType	是	是	String	类型示例值： subaccount
NeedResetPassword	是	是	Int64	是否需要重置密码示例值： 0
ConsoleLogin	是	是	Int64	是否允许控制台登录示例值： 1
WxzsStatus	是	是	Int64	微信公众号关注状态示例值： 0
PermType	是	是	Array of String	权限类型示例值： ["0"]
NickName	是	是	String	昵称示例值： nick
QywxUserId	否	否	String	企业微信用户id 示例值： qywxuserid
UserAttributeAndValues	否	是	Array of AccountAttributeAndValue	扩展属性示例值：查看
Status	否	否	Int64	状态示例值： 0
LoginStatus	否	否	Int64	登陆状态示例值： 0
VerifyPhone	否	否	String	VerifyPhone 示例值： 11111111111
VerifyEmail	否	否	String	VerifyEmail 示例值： mail@mail.com
VerifyCountryCode	否	否	String	VerifyCountryCode 示例值： 86

SubAccountInfo

子账户用户信息

被如下接口引用：UpdateSubAccount

名称	必选	允许NULL	类型	描述
CanLogin	否	否	String	能否登陆，0-否，1-可示例值： 1
ConsoleLogin	否	否	String	是否是控制台登陆，1-是示例值： 1
CountryCode	否	否	String	国家编码示例值： 86
Name	否	否	String	用户名示例值：名称
NeedResetPassword	否	否	String	是否需要重置密码，1-是示例值： 0
PhoneNum	否	否	String	手机号示例值： 11111111111
Remark	否	否	String	备注示例值：备注
SystemType	否	否	String	账户类型示例值： subaccount
Uid	否	否	String	接收者用户ID 示例值： 1280504
Uin	否	否	String	账户唯一id 示例值： 110000000001
Password	否	否	String	密码示例值： password
WxzsStatus	否	否	Int64	微信消息状态示例值： 0
UserType	否	否	Int64	用户类型示例值： 0
Email	否	否	String	联系邮箱示例值： mail@mail.com
Account	否	否	String	用户名示例值： username
Lang	否	否	String	语言示例值： en-US
NickName	否	否	String	昵称示例值：昵称

GroupData

用户组相关信息

被如下接口引用：GetAllSubUser

名称	必选	允许NULL	类型	描述
GroupId	否	否	Int64	用户组id 示例值： 1000
GroupName	是	否	String	用户组名称示例值： group1
GroupNum	是	否	Int64	用户组成员数量示例值： 100
Channel	是	否	Int64	创建渠道示例值： 0
GroupMem	否	否	Array of Uint64	组成员uid 示例值： [1280504,1280505]

ApiKey

API密钥数据列表

被如下接口引用：CreateApiKey、CreateCollApiKey、QueryApiKey、QueryCollApiKey、QueryKeyBySecretId

名称	必选	允许NULL	类型	描述
SecretId	否	否	String	密钥ID 示例值： AKID***wdew
CreateTime	否	否	Uint64	创建时间(时间戳) 示例值： 1615990212
Status	否	否	Uint64	状态(2:有效, 3:禁用) 示例值： 2
SecretKey	否	否	String	密钥Key 示例值： ACCF***wdew
Source	否	否	Uint64	来源示例值： 0
Remark	否	否	String	备注示例值： remark

GroupMeta

用户组元信息

被如下接口引用：GetUserGroupList、ListAllUserGroup

名称	必选	允许NULL	类型	描述
GroupId	否	是	Int64	用户组id 示例值： 100
GroupName	否	是	String	用户组名称示例值： group1

OwnerInfo

主账号信息

被如下接口引用：ListMaskedSubAccounts、ListSubAccounts

名称	必选	允许NULL	类型	描述
Uin	是	是	Uint64	主帐号Uin 示例值： 130000000001
UserName	是	是	String	用户名示例值： username
CheckStatus	是	否	Uint64	校验状态示例值： 0

AccountDetail

账号详情

被如下接口引用：AddSubAccount、ListGroups

名称	必选	允许NULL	类型	描述
ActionFlag	否	否	ActionLoginFlag	敏感操作标识示例值：查看
ConsoleLogin	否	否	String	是否允许控制台登录, 传0不可登陆控制台, 传1可以登陆控制台。示例值: 1 示例值： 1
LoginFlag	否	否	ActionLoginFlag	登录保护示例值：查看
NeedResetPassword	否	否	String	是否需要重置密码, 传0不需要重置密码, 传1需要重置密码。示例值: 0 示例值： 0
Password	否	否	String	用户密码。示例值: password 示例值： password
UseApi	否	否	String	使用Api, 传0不使用Api, 传1使用Api。示例值: 1 示例值： 1
TokenType	否	否	Int64	分配设备类型,传0不分配设备,传2分配设备。示例值: 0 示例值： 0

GroupUidUinInfo

用户组和用户信息

被如下接口引用：DeleteSubAccount

名称	必选	允许NULL	类型	描述
Uid	是	否	Uint64	子用户Uid 示例值： 1258042
Uin	是	否	Uint64	子用户Uin 示例值： 130000000001
GroupId	是	否	Int64	用户组ID 如果没有任何组传递-1,传入指定组id表示将用户从组删除示例值： 15094

ApiKeyDetail

持久密钥详情

被如下接口引用：GetApiKey

名称	必选	允许NULL	类型	描述
SecretId	否	否	String	密钥ID 示例值： AK*************
SecretKey	否	否	String	密钥Key 示例值： TR*************
CreateTime	否	否	Uint64	创建时间(时间戳) 示例值： 2014-08-03 12:00:00
Status	否	否	Uint64	状态(2:有效, 3:禁用) 示例值： 1
Source	否	否	Uint64	来源，默认0 示例值： 1
Remark	否	是	String	描述示例值： aremark

AttachEntityOfPolicy

策略关联的实体信息

被如下接口引用：ListEntitiesForPolicy

名称	必选	允许NULL	类型	描述
Id	是	否	String	实体ID 示例值： 1000001
Name	是	是	String	实体名称示例值： policygen-20141112201913
Uin	是	是	Uint64	实体Uin 示例值： 3449203261
RelatedType	是	否	Uint64	关联类型。1 用户关联； 2 用户组关联示例值： 1

AttachedStrategyInfo

策略信息

被如下接口引用：DescribeAttachedEntityPolicies

名称	必选	允许NULL	类型	描述
PolicyId	否	否	Uint64	策略ID。示例值： 1000
PolicyName	否	否	String	策略名称。示例值： policygen-20141112201913
AddTime	否	是	Datetime	策略创建时间。示例值： 2014-08-03 12:00:00
CreateMode	否	是	Uint64	创建来源，1 通过控制台创建, 2 通过策略语法创建。示例值： 1
Description	否	是	String	策略描述。示例值： adesc

ServicePermItem

接口

被如下接口引用：GetServicePermList

名称	必选	允许NULL	类型	描述
AddTime	否	否	Datetime	创建时间示例值： 2014-08-03 12:00:00
ApiAddr	否	否	String	ApiAddr 示例值： ApiAddr
ApiZhName	否	否	String	中文描述示例值： ADMIN
AuthFunction	否	否	String	鉴权接口示例值： AuthFunction
CWildcardName	否	否	String	CWildcardName 示例值： CWildcardName
InterfaceEnName	否	否	String	接口名示例值： CVM
InterfaceLevel	否	否	String	鉴权粒度，0:接口级别、1:资源级别示例值： 1
IsAuthBusiness	否	否	String	鉴权方式，0:由云API转发鉴权、1:业务自行调用鉴权接口示例值： 1
IsNeedObject	否	否	String	IsNeedObject 示例值： 1
IsSeen	否	否	Uint64	IsSeen 示例值： 1
IsSeenAtGenerator	否	否	String	策略生成器是否可见示例值： 1
IsSpResource	否	否	String	IsSpResource 示例值： 1
IsUserSet	否	否	String	IsUserSet 示例值： 1
PermId	否	否	String	Id 示例值： 1000
ReadWriteDetail	否	否	String	接口类别示例值：接口类别：0.读取，1.写入，2.标记，3.列表
ResourceType	否	是	String	资源类别示例值： cvm
UpdateTime	否	否	String	更新时间示例值： 2014-08-03 12:00:00
Weight	否	否	String	Weight 示例值： 1
Writter	否	否	String	操作者示例值： admin
ServiceName	否	否	String	服务名示例值： cvm
ProductShortCode	否	否	String	ProductShortCode 示例值： p_cvm
ProductShortName	否	否	String	ProductShortName 示例值： p_cvm
ServiceType	否	否	String	服务类型示例值： cvm
Interface	否	否	String	接口名示例值： CVM
InterfaceName	否	否	String	接口名示例值： CVM

ListOpenPlatform

第三方平台详细信息

被如下接口引用：ListOpenPlatforms

名称	必选	允许NULL	类型	描述
OpenId	是	否	Int64	openid 示例值： 1
AppId	是	否	String	app id 示例值： 1255000002
OpenName	是	否	String	app name 示例值： ""
OpenLogo	是	否	String	open logo 示例值： ""
OpenHome	是	否	String	第三方平台主页示例值： ""
OpenType	是	否	Int64	授权类型示例值： 0
Uin	是	否	Uint64	申请账号示例值： 110000000001
Status	是	否	Int64	状态示例值： 0
Domain	是	否	String	第三方平台域名示例值： ""
State	是	否	Int64	冻结状态，0-非冻结，1-冻结示例值： 0
Modifier	是	否	String	修改人示例值： 110000000001
ModifyTime	是	否	String	更新时间示例值： 2019-04-29 21:18:28
CreateTime	是	否	String	创建时间示例值： 2019-04-29 21:18:28
Memo	是	否	String	备注示例值： ""

UserInfo

用户信息

被如下接口引用：AddSubAccount、ListGroups

名称	必选	允许NULL	类型	描述
CanLogin	否	否	String	子账号类型，传0不可登陆控制台，传1可以登陆控制台。示例值： 1
CountryCode	否	否	String	区号。示例值： 86
Detail	否	否	AccountDetail	详情示例值：查看
Name	否	否	String	名称。示例值： name
PhoneNum	否	否	String	电话号码。示例值： 11111111111
SystemType	否	否	String	账号类型。示例值： Subaccount
Email	否	否	String	安全邮箱。示例值： mail@mail.com
NickName	否	否	String	昵称。示例值： nickname
Remark	否	否	String	备注。示例值： remark
WxzsStatus	否	否	Int64	微信登陆状态。示例值： 0
ContactMail	否	否	String	联系邮箱。示例值： mail@mail.com
IsReceiverOwner	否	否	Int64	是否是主账号。传1代表主账号, 传0代表子账号。示例值： 1
IdentifyType	否	否	Int64	身份类型。示例值： 0

AttachPolicyInfo

关联策略信息

被如下接口引用：ListAttachedGroupPolicies

名称	必选	允许NULL	类型	描述
PolicyId	是	否	Uint64	策略id 示例值： 1000
PolicyName	是	是	String	策略名称示例值： policygen-20141112201913
AddTime	是	是	Datetime	创建时间示例值： 2014-08-03 12:00:00
CreateMode	是	是	Uint64	创建来源，1 通过控制台创建, 2 通过策略语法创建。示例值： 1

GroupMember

用户组成员

被如下接口引用：AddUserToGroup、RemoveUserFromGroup、UpdateGroupMember

名称	必选	允许NULL	类型	描述
Uid	是	否	String	用户id 示例值： 100
GroupId	是	否	String	组id 示例值： 100

StrategyInfo

策略信息

被如下接口引用：ListPolicies

名称	必选	允许NULL	类型	描述
PolicyId	是	否	Uint64	策略ID。示例值： 1
PolicyName	是	否	String	策略名称。示例值： AdministratorAccess
AddTime	是	是	Datetime	策略创建时间。示例值： 2016-06-02 19:40:09
Type	是	否	Uint64	策略类型。1 表示自定义策略，2 表示预设策略。示例值： 1
Description	是	是	String	策略描述。示例值：该策略允许您管理账户内所有用户及其权限、财务相关的信息、云服务资产。
CreateMode	是	否	Uint64	创建来源，1 通过控制台创建, 2 通过策略语法创建。示例值： 1
Attachments	否	否	Uint64	关联的用户数示例值： 1
ServiceType	是	是	String	策略关联的产品示例值： cam
IsAttached	否	是	Uint64	当需要查询标记实体是否已经关联策略时不为null。0表示未关联策略，1表示已关联策略示例值： 1
Deactived	否	是	Uint64	是否已下线，传1代表已下线，传0代表未下线示例值： 0
DeactivedDetail	否	是	Array of String	已下线产品列表示例值： ["deacproduct"]
IsCheck	是	是	Uint64	是否进行安全性校验，传1代表进行安全校验，传0代表不校验示例值： 1
PolicyDocument	否	否	String	策略语法示例值： {\"version\":\"2.0\",\"statement\":[{\"effect\":\"allow\",\"action\":[\"cvm:ModifyDiskAttributes\"],\"resource\":[\"*\"],\"condition\":{\"ip_equal\":{\"qcs:ip\":[\"1.1.1.1\"]}}},{\"effect\":\"allow\",\"action\":[\"cos:PutObject\"],\"resource\":[\"qcs::cos::uid/1255000018:rules-package-ftp-1255000018/waf_rules.zip\"],\"condition\":{\"ip_equal\":{\"qcs:ip\":[\"1.1.1.1\"]}}}]}
UpdateTime	否	否	String	修改时间示例值： 2016-06-02 19:40:09

AttributeInfo

属性

被如下接口引用：AddAttributeValues

名称	必选	允许NULL	类型	描述
AttributeName	否	是	String	属性名称示例值： ""
Attribute	否	是	String	属性示例值： ""
AttributeValue	否	是	String	属性值示例值： ""

ResourceTypeItem

资源类型

被如下接口引用：GetServiceList

名称	必选	允许NULL	类型	描述
ResourceEnName	否	否	String	英文名示例值： ""
ResourceName	否	否	String	中文名示例值： ""
ResourceType	否	否	String	资源类型示例值： ""
ServiceType	否	否	String	服务类型示例值： ""

UserLists

GetUserListByUinList

被如下接口引用：GetUserListByUinList

名称	必选	允许NULL	类型	描述
CountryCode	否	否	String	CountryCode 示例值： 86
IsAuthed	否	否	Int64	IsAuthed 示例值： 0
UserCamUid	否	否	Int64	UserCamUid 示例值： 1280504
UserCellphone	否	否	String	UserCellphone 示例值： 11111111111
UserEmail	否	否	String	UserEmail 示例值： mail@mail.com
UserId	否	否	String	UserId 示例值： 1280504
UserUin	否	否	Uint64	UserUin 示例值： 110000000001
UserName	否	否	String	UserName 示例值： username
UserIsLocked	否	否	Int64	UserIsLocked 示例值： 1

过滤条件数据结构

被如下接口引用：ListMaskedSubAccounts、ListSubAccounts

名称	必选	允许NULL	类型	描述
Operator	是	否	String	操作符示例值： ""
Attr	是	否	String	属性示例值： ""
Value	是	否	String	匹配值示例值： ""

RoleInfo

角色详细信息

被如下接口引用：DescribeRoleList、GetRole

名称	必选	允许NULL	类型	描述
RoleId	是	否	String	角色ID 示例值： 12
RoleName	是	否	String	角色名称示例值： QCS
PolicyDocument	是	否	String	角色的策略文档示例值： {\"version\":\"2.0\",\"statement\":[{\"effect\":\"allow\",\"action\":[\"cvm:ModifyDiskAttributes\"],\"resource\":[\"*\"],\"condition\":{\"ip_equal\":{\"qcs:ip\":[\"1.1.1.1\"]}}},{\"effect\":\"allow\",\"action\":[\"cos:PutObject\"],\"resource\":[\"qcs::cos::uid/1255000018:rules-package-ftp-1255000018/waf_rules.zip\"],\"condition\":{\"ip_equal\":{\"qcs:ip\":[\"1.1.1.1\"]}}}]}
Description	是	否	String	角色描述示例值： Description
AddTime	是	否	String	角色的创建时间示例值： 2020-01-01 01:01:01
UpdateTime	是	否	String	角色的最近一次时间示例值： 2020-01-01 01:01:01
DeletionTaskId	否	是	String	兼容公有云字段，无含义示例值： 1
ConsoleLogin	是	否	Uint64	角色是否允许登录，传1代表允许登录，传0代表不允许示例值： 1
RoleType	否	是	String	角色类型，取user、system或service_linked 示例值： user
SessionDuration	否	是	Uint64	有效时间示例值： 7200

RolePolicyList

角色策略列表

被如下接口引用：GetServiceRoleInfo

名称	必选	允许NULL	类型	描述
IsHidden	否	否	Uint64	状态示例值： 1
PolicyId	否	否	String	策略Id 示例值： 100
PolicyName	否	否	String	策略名示例值： policygen-20141112201913

AttachedPolicyOfRole

角色关联的策略信息

被如下接口引用：ListAttachedRolePolicies

名称	必选	允许NULL	类型	描述
PolicyId	是	否	Uint64	策略ID 示例值： 1000
PolicyName	是	否	String	策略名称示例值： policygen-20141112201913
AddTime	是	否	String	绑定时间示例值： 2014-08-03 12:00:00
PolicyType	是	是	String	策略类型，User表示自定义策略，QCS表示预设策略示例值：按策略类型过滤，User表示仅查询自定义策略，QCS表示仅查询预设策略
CreateMode	是	否	Uint64	策略创建方式，1表示按产品功能或项目权限创建，其他表示按策略语法创建示例值： 1

Filter

过滤条件组合

被如下接口引用：ListMaskedSubAccounts、ListSubAccounts

名称	必选	允许NULL	类型	描述
Keywords	否	否	Array of FilterItem	过滤条件组合示例值：查看
Operator	是	否	String	操作符示例值： ""

GroupInfoWithRemark

被如下接口引用：ListUsersForGroup

名称	必选	允许NULL	类型	描述
GroupId	否	否	Int64	GroupId 示例值： 100
GroupName	否	否	String	GroupName 示例值： name
Remark	否	否	String	Remark 示例值： remark

AddSubAccountDetail

新增用户详情

被如下接口引用：AddSubAccount

名称	必选	允许NULL	类型	描述
Name	否	否	String	用户名示例值： name
Token	否	否	String	token 示例值： ""
Password	否	否	String	密码示例值： password
SecretId	否	否	String	secretid 示例值： ""
SecretKey	否	否	String	secretKey 示例值： ""
NickName	否	否	String	昵称示例值： nickname
Uin	否	否	Uint64	uin 示例值： 110000000001
Nickname	否	否	String	Nickname 示例值： nickname

AttachedStrategyInfoPack

策略信息包

被如下接口引用：DescribeAttachedEntityPolicies

名称	必选	允许NULL	类型	描述
List	否	否	Array of AttachedStrategyInfo	策略数组，数组每个成员包括 policyId、policyName、addTime、type、description、 createMode 字段。其中：示例值：查看
TotalNum	否	否	Uint64	策略数示例值： 100
Id	否	否	String	入参Type=1时表示uin，2时表示groupId 示例值： 100

ExtAttr

用户属性集合

被如下接口引用：DescribeSubReceiver

名称	必选	允许NULL	类型	描述
NeedResetToken	是	否	Int64	需要重置mfa的token 示例值： 0
NeedResetStoken	是	否	Int64	需要重置mfa的stoken 示例值： 0

UserData

用户信息数据

被如下接口引用：GetAllSubUser

名称	必选	允许NULL	类型	描述
Uid	是	否	Uint64	子用户id 示例值： 1258042
Uin	是	否	Uint64	账号唯一序列号示例值： 110000000001
Name	是	否	String	用户名称示例值： name
PhoneNum	是	否	String	电话号码示例值： 11111111111
CountryCode	是	否	String	区号示例值： 86
PhoneFlag	是	否	Int64	电话认证标志示例值： 1
Email	是	否	String	邮箱地址示例值： mail@mail.com
EmailFlag	是	否	Int64	邮箱是否认证示例值： 1
UserType	是	否	Int64	用户类型示例值： 0
CreateTime	是	否	String	创建时间示例值： 2019-04-29 21:18:28
WechatFlag	是	否	Int64	微信标识示例值： 0
SystemType	是	否	String	账号系统类型示例值： Subaccount
IsReceiverOwner	是	否	Int64	是否为主账号示例值： 1
PermType	否	否	Array of String	PermType 示例值： ["0"]

DescribeGroupsInfo

被如下接口引用：DescribeGroups

名称	必选	允许NULL	类型	描述
Channel	否	否	Int64	Channel 示例值： 3
CreateTime	否	否	String	CreateTime 示例值： 2025-02-21 11:30:44
GroupId	否	否	Int64	GroupId 示例值： 100
GroupName	否	否	String	GroupName 示例值： name
GroupNum	否	否	Int64	GroupNum 示例值： 3
GroupType	否	否	Int64	GroupType 示例值： 0
Remark	否	否	String	Remark 示例值： Remark
UserInfo	否	否	Array of ListGroupUserInfo	UserInfo 示例值：查看

ServiceApiListInfo

服务的API信息

被如下接口引用：GetServiceApiList

名称	必选	允许NULL	类型	描述
Name	是	否	String	API名称示例值： CreateInstance
IsNeedObject	是	是	String	是否需要关联对象示例值： ["1"]
Desc	是	是	String	描述示例值：创建实例
ReadWriteDetail	是	是	Uint64	接口类别：0.读取，1.写入，2.标记，3.列表示例值： 1
InterfaceLevel	是	是	Uint64	授权粒度：0.接口级，1.资源级示例值： 1
ResourceExample	是	是	String	资源六段式范例示例值： [qcs::cvm:region:uin/110000001207:volume/*]

GroupInfo

用户组信息

被如下接口引用：GetGroupList、GetGroupsSubAccount、GetSubsGroup、ListGroups、ListGroupsForConsole、ListMaskedSubAccounts、ListSubAccounts

名称	必选	允许NULL	类型	描述
GroupId	否	否	Uint64	组id 示例值： 15094
GroupName	否	否	String	组名称示例值： groupname
Channel	否	是	Int64	息接收渠道 0:无 1: 短信 2：邮件 3：短信+邮件示例值： 0
Remark	否	是	String	备注示例值： remark
CreateTime	否	是	String	创建时间示例值： 2019-04-29 21:18:28
UserInfo	否	是	Array of SubAccountFilter	用户组成员信息示例值：查看
GroupType	否	是	Int64	用户组类型，0-自定义，1-预设示例值： 0
GroupNum	否	否	Int64	组成员数示例值： 2

GroupUserInfo

用户组下用户信息

被如下接口引用：GetGroupsSubAccount

名称	必选	允许NULL	类型	描述
Uid	是	是	Uint64	接收者用户id 示例值： 1258042
Uin	是	是	Uint64	账户唯一id 示例值： 130000000001
Name	是	是	String	用户名示例值： username
PhoneNum	是	是	String	手机号示例值： 11111111111
CountryCode	是	是	String	国家编码示例值： 86
PhoneFlag	是	是	String	手机号标识示例值： 1
Email	是	是	String	邮箱示例值： mail@mail.com
EmailFlag	是	是	String	邮箱标识示例值： 1
UserType	是	是	Int64	用户类型示例值： 0
CreateTime	是	是	String	创建时间示例值： 2019-04-29 21:18:28
IsReceiverOwner	是	是	String	是否是主账户示例值： 1
SystemType	是	是	String	账户类型示例值： subaccount
NickName	是	是	String	昵称示例值： nick

Receiver

消息接收人信息

被如下接口引用：DescribeSubAccountContacts

名称	必选	允许NULL	类型	描述
Uid	是	否	Uint64	id 示例值： 1258042
Name	是	否	String	名字示例值： username
Remark	是	否	String	备注示例值： remark
PhoneNumber	是	否	String	手机号码示例值： 11111111111
PhoneFlag	是	否	Int64	手机号码是否验证示例值： 1
Email	是	否	String	邮箱示例值： mail@mail.com
EmailFlag	是	否	Int64	邮箱是否验证示例值： 1
IsReceiverOwner	是	否	Int64	是否主联系人示例值： 1
WechatFlag	否	否	Int64	是否允许微信接收通知示例值： 0
Uin	是	否	Uint64	账号uin 示例值： 130000000001

ListGroupUserInfo

被如下接口引用：DescribeGroups、ListUsersForGroup

名称	必选	允许NULL	类型	描述
CountryCode	否	否	String	CountryCode 示例值： 86
CreateTime	否	否	String	CreateTime 示例值： 2025-01-17 14:21:07
Email	否	否	String	Email 示例值： mail@mail.com
EmailFlag	否	是	Int64	EmailFlag 示例值： 0
IsReceiverOwner	否	否	Int64	IsReceiverOwner 示例值： 0
JoinTime	否	否	String	JoinTime 示例值： 2025-01-17 14:21:07
Name	否	否	String	Name 示例值： Name
NickName	否	否	String	NickName 示例值： NickName
PhoneFlag	否	否	Int64	PhoneFlag 示例值： 0
PhoneNum	否	否	String	PhoneNum 示例值： 11111111111
SystemType	否	否	Int64	SystemType 示例值： 0
Uid	否	否	Uint64	Uid 示例值： 1258683
Uin	否	否	Uint64	Uin 示例值： 130000000640
UserType	否	否	Int64	UserType 示例值： 3
QywxUserId	否	否	String	QywxUserId 示例值： ""

ActionLoginFlag

登录操作敏感标识

被如下接口引用：AddSubAccount、ListGroups

名称	必选	允许NULL	类型	描述
Phone	否	否	String	电话, 传0不开启敏感操作保护, 传1开启敏感操作保护。示例值: 0 示例值： 0
Stoken	否	否	String	软Token, 传0不开启敏感操作保护, 传1开启敏感操作保护。示例值: 0 示例值： 0
Token	否	否	String	硬Token, 传0不开启敏感操作保护, 传1开启敏感操作保护。示例值: 0 示例值： 0
Ukey	否	否	String	ukey, 传0不开启敏感操作保护, 传1开启敏感操作保护。示例值: 0 示例值： 0

ServiceApiInfo

服务及其API信息

被如下接口引用：GetServiceApiList

名称	必选	允许NULL	类型	描述
Name	是	否	String	服务名称示例值：用户与权限
ServiceType	是	否	String	服务ID 示例值： cam
ArnDocument	是	是	String	服务介绍文档链接示例值： https://www.example.com/document/product/378/8965
ApiList	否	是	Array of ServiceApiListInfo	API信息列表示例值：查看
ConditionKeyList	否	是	Array of String	条件规则列表示例值： ["qcs:ip"]

StrategyInfoForAction

策略详情

被如下接口引用：ListPoliciesByAction

名称	必选	允许NULL	类型	描述
PolicyId	否	否	Uint64	策略ID。示例值： 1
PolicyName	否	否	String	策略名称。示例值： AdministratorAccess
AddTime	否	否	Datetime	策略创建时间。示例值： 2016-06-02 19:40:09
Type	否	否	Uint64	策略类型。1 表示自定义策略，2 表示预设策略。示例值： 1
Description	否	否	String	策略描述。示例值：该策略允许您管理账户内所有用户及其权限、财务相关的信息、云服务资产。
CreateMode	否	否	Uint64	创建来源，1 通过控制台创建, 2 通过策略语法创建。示例值： 1
Attachments	否	是	Uint64	关联的用户数示例值： 1
ServiceType	否	否	String	策略关联的产品示例值： cam
IsAttached	否	是	Uint64	当需要查询标记实体是否已经关联策略时不为null。0表示未关联策略，1表示已关联策略示例值： 1
Deactived	否	是	Uint64	是否已下线，传1代表已下线，传0代表未下线示例值： 0
DeactivedDetail	否	是	Array of String	已下线产品列表示例值： ["cvm"]
IsCheck	否	是	String	是否进行安全性校验，传1代表进行安全校验，传0代表不校验示例值： 1
PolicyDocument	否	否	String	策略语法示例值： {"version":"2.0","statement":[{"action":["cam:","account:"],"resource":["*"],"effect":"allow"}]}
UpdateTime	否	否	String	修改时间示例值： 2016-06-02 19:40:09

UserGroup

用户及用户组信息

被如下接口引用：GetUserGroupList、ListAllUserGroup

名称	必选	允许NULL	类型	描述
Uid	是	是	Uint64	接收者用户id 示例值： 1258042
Uin	是	是	Uint64	账户唯一id 示例值： 110000000001
Name	是	是	String	用户名示例值： name
IsReceiverOwner	是	是	Int64	是否是主账户示例值： 1
Group	是	是	Array of GroupMeta	用户组信息示例值：查看

AttachedUserPolicyGroupInfo

用户关联策略(随组管理)信息

被如下接口引用：ListAttachedUserAllPolicies

名称	必选	允许NULL	类型	描述
GroupId	否	否	Uint64	分组ID 示例值： 10012
GroupName	否	否	String	分组名称示例值： group_one

UpdateGroupInfo

更新用户组信息

被如下接口引用：UpdateSubAccount

名称	必选	允许NULL	类型	描述
GroupId	是	否	Uint64	用户组id 示例值： 15094
Uid	是	否	Uint64	用户id 示例值： 1258042
GroupName	否	否	String	用户组名称示例值： name
Channel	否	否	Int64	息接收渠道 0:无 1: 短信 2：邮件 3：短信+邮件示例值： 0

CasProviderItem

cas server 配置信息

被如下接口引用：DescribeCasProvider

名称	必选	允许NULL	类型	描述
Id	是	否	Int64	provider id 示例值： 1
CreateUin	是	否	Uint64	创建账户uin 示例值： 110000000001
OwnerUin	是	否	Uint64	主账户uin 示例值： 110000000001
Name	是	否	String	名称示例值： name
Desc	是	否	String	描述示例值： desc
ProviderType	是	否	Int64	provider类型示例值： 8
Status	是	否	Int64	状态示例值： 0
ModifyTime	是	否	String	修改时间示例值： 2019-04-29 21:18:28
CreateTime	是	否	String	创建时间示例值： 2019-04-29 21:18:28
SAMLMetadata	是	否	String	SAML元数据示例值： ""
SAMLEntityId	是	否	String	SAML实例id 示例值： ""
SAMLSingleSignOn	是	否	String	SAML登陆跳转示例值： ""
SAMLSingleLogout	是	否	String	SAML登出跳转示例值： ""
SAMLKeys	是	否	String	SAML关键字示例值： ""
Cas	是	否	String	Cas 示例值： ""
CasRoot	是	否	String	cas根地址示例值： https://cas.yfm13.fsphere.cn/
CasLoginUrl	是	否	String	cas登陆url 示例值： https://cas.yfm13.fsphere.cn/cas/login
CasValidateUrl	是	否	String	cas校验url 示例值： https://cas.yfm13.fsphere.cn/cas/serviceValidate
CasLogoutUrl	是	否	String	cas登出url 示例值： https://cas.yfm13.fsphere.cn/cas/logout
Oauth	是	否	String	oauth配置示例值： ""

AccountAttributeAndValue

扩展属性值

被如下接口引用：GetGroupList、GetGroupsSubAccount、GetSubsGroup、ListGroups、ListGroupsForConsole、ListMaskedSubAccounts、ListSubAccounts

名称	必选	允许NULL	类型	描述
AttributeName	否	否	String	属性名称示例值： ""
Attribute	否	否	String	属性示例值： ""
AttributeId	否	否	Int64	属性id 示例值： ""
ValueId	否	否	Int64	值id 示例值： ""
Uin	否	否	Int64	uin 示例值： 110000000001
Value	否	否	String	值示例值： ""

API文档中心

数据结构

AttachedUserPolicy

ServiceItem

UserList

OwnerAccountAttribute

PasswordRules

SubAccountFilter

SubAccountInfo

GroupData

ApiKey

GroupMeta

OwnerInfo

AccountDetail

GroupUidUinInfo

ApiKeyDetail

AttachEntityOfPolicy

AttachedStrategyInfo

ServicePermItem

ListOpenPlatform

UserInfo

AttachPolicyInfo

GroupMember

StrategyInfo

AttributeInfo

ResourceTypeItem

UserLists

FilterItem

RoleInfo

RolePolicyList

AttachedPolicyOfRole

Filter

GroupInfoWithRemark

AddSubAccountDetail

AttachedStrategyInfoPack

ExtAttr

UserData

DescribeGroupsInfo

ServiceApiListInfo

GroupInfo

GroupUserInfo

Receiver

ListGroupUserInfo

ActionLoginFlag

ServiceApiInfo

StrategyInfoForAction

UserGroup

AttachedUserPolicyGroupInfo

UpdateGroupInfo

CasProviderItem

AccountAttributeAndValue