Class: TencentCloud::Organization::V20210331::ListUsersRequest

Inherits:
Common::AbstractModel
  • Object
show all
Defined in:
lib/v20210331/models.rb

Overview

ListUsers请求参数结构体

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(zoneid = nil, userstatus = nil, usertype = nil, filter = nil, maxresults = nil, nexttoken = nil, filtergroups = nil, sortfield = nil, sorttype = nil, offset = nil) ⇒ ListUsersRequest

Returns a new instance of ListUsersRequest.



5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
 
# File 'lib/v20210331/models.rb', line 5617

def initialize(zoneid=nil, userstatus=nil, usertype=nil, filter=nil, maxresults=nil, nexttoken=nil, filtergroups=nil, sortfield=nil, sorttype=nil, offset=nil)
  @ZoneId = zoneid
  @UserStatus = userstatus
  @UserType = usertype
  @Filter = filter
  @MaxResults = maxresults
  @NextToken = nexttoken
  @FilterGroups = filtergroups
  @SortField = sortfield
  @SortType = sorttype
  @Offset = offset
end

Instance Attribute Details

#Filter ⇒ Object

Parameters:

  • ZoneId: —

    空间 ID。

  • UserStatus: —

    用户状态 Enabled：启用， Disabled：禁用。

  • UserType: —

    用户类型 Manual：手动创建，Synchronized：外部导入。

  • Filter: —

    过滤条件。 目前仅支持用户名，邮箱，用户userId，描述

  • MaxResults: —

    每页的最大数据条数。 取值范围：1~100。 默认值：10。

  • NextToken: —

    查询返回结果下一页的令牌。首次调用 API 不需要NextToken。 当您首次调用 API 时，如果返回数据总条数超过MaxResults限制，数据会被截断，只返回MaxResults条数据，同时，返回参数IsTruncated为true，返回一个NextToken。您可以使用上一次返回的NextToken继续调用 API，其他请求参数保持不变，查询被截断的数据。您可以按此方法经过多次查询，直到IsTruncated为false时，表示全部数据查询完毕。

  • FilterGroups: —

    筛选的用户组，该用户组关联的子用户会返回IsSelected=1

  • SortField: —

    排序的字段，目前只支持CreateTime，默认是CreateTime字段

  • SortType: —

    排序类型：Desc 倒序 Asc 正序，需要您和SortField一起设置

  • Offset: —

    翻页offset. 不要与NextToken同时使用，优先使用NextToken



5615
5616
5617
 
# File 'lib/v20210331/models.rb', line 5615

def Filter
  @Filter
end

#FilterGroups ⇒ Object

Parameters:

  • ZoneId: —

    空间 ID。

  • UserStatus: —

    用户状态 Enabled：启用， Disabled：禁用。

  • UserType: —

    用户类型 Manual：手动创建，Synchronized：外部导入。

  • Filter: —

    过滤条件。 目前仅支持用户名，邮箱，用户userId，描述

  • MaxResults: —

    每页的最大数据条数。 取值范围：1~100。 默认值：10。

  • NextToken: —

    查询返回结果下一页的令牌。首次调用 API 不需要NextToken。 当您首次调用 API 时，如果返回数据总条数超过MaxResults限制，数据会被截断，只返回MaxResults条数据，同时，返回参数IsTruncated为true，返回一个NextToken。您可以使用上一次返回的NextToken继续调用 API，其他请求参数保持不变，查询被截断的数据。您可以按此方法经过多次查询，直到IsTruncated为false时，表示全部数据查询完毕。

  • FilterGroups: —

    筛选的用户组，该用户组关联的子用户会返回IsSelected=1

  • SortField: —

    排序的字段，目前只支持CreateTime，默认是CreateTime字段

  • SortType: —

    排序类型：Desc 倒序 Asc 正序，需要您和SortField一起设置

  • Offset: —

    翻页offset. 不要与NextToken同时使用，优先使用NextToken



5615
5616
5617
 
# File 'lib/v20210331/models.rb', line 5615

def FilterGroups
  @FilterGroups
end

#MaxResults ⇒ Object

Parameters:

  • ZoneId: —

    空间 ID。

  • UserStatus: —

    用户状态 Enabled：启用， Disabled：禁用。

  • UserType: —

    用户类型 Manual：手动创建，Synchronized：外部导入。

  • Filter: —

    过滤条件。 目前仅支持用户名，邮箱，用户userId，描述

  • MaxResults: —

    每页的最大数据条数。 取值范围：1~100。 默认值：10。

  • NextToken: —

    查询返回结果下一页的令牌。首次调用 API 不需要NextToken。 当您首次调用 API 时，如果返回数据总条数超过MaxResults限制，数据会被截断，只返回MaxResults条数据，同时，返回参数IsTruncated为true，返回一个NextToken。您可以使用上一次返回的NextToken继续调用 API，其他请求参数保持不变，查询被截断的数据。您可以按此方法经过多次查询，直到IsTruncated为false时，表示全部数据查询完毕。

  • FilterGroups: —

    筛选的用户组，该用户组关联的子用户会返回IsSelected=1

  • SortField: —

    排序的字段，目前只支持CreateTime，默认是CreateTime字段

  • SortType: —

    排序类型：Desc 倒序 Asc 正序，需要您和SortField一起设置

  • Offset: —

    翻页offset. 不要与NextToken同时使用，优先使用NextToken



5615
5616
5617
 
# File 'lib/v20210331/models.rb', line 5615

def MaxResults
  @MaxResults
end

#NextToken ⇒ Object

Parameters:

  • ZoneId: —

    空间 ID。

  • UserStatus: —

    用户状态 Enabled：启用， Disabled：禁用。

  • UserType: —

    用户类型 Manual：手动创建，Synchronized：外部导入。

  • Filter: —

    过滤条件。 目前仅支持用户名，邮箱，用户userId，描述

  • MaxResults: —

    每页的最大数据条数。 取值范围：1~100。 默认值：10。

  • NextToken: —

    查询返回结果下一页的令牌。首次调用 API 不需要NextToken。 当您首次调用 API 时，如果返回数据总条数超过MaxResults限制，数据会被截断，只返回MaxResults条数据，同时，返回参数IsTruncated为true，返回一个NextToken。您可以使用上一次返回的NextToken继续调用 API，其他请求参数保持不变，查询被截断的数据。您可以按此方法经过多次查询，直到IsTruncated为false时，表示全部数据查询完毕。

  • FilterGroups: —

    筛选的用户组，该用户组关联的子用户会返回IsSelected=1

  • SortField: —

    排序的字段，目前只支持CreateTime，默认是CreateTime字段

  • SortType: —

    排序类型：Desc 倒序 Asc 正序，需要您和SortField一起设置

  • Offset: —

    翻页offset. 不要与NextToken同时使用，优先使用NextToken



5615
5616
5617
 
# File 'lib/v20210331/models.rb', line 5615

def NextToken
  @NextToken
end

#Offset ⇒ Object

Parameters:

  • ZoneId: —

    空间 ID。

  • UserStatus: —

    用户状态 Enabled：启用， Disabled：禁用。

  • UserType: —

    用户类型 Manual：手动创建，Synchronized：外部导入。

  • Filter: —

    过滤条件。 目前仅支持用户名，邮箱，用户userId，描述

  • MaxResults: —

    每页的最大数据条数。 取值范围：1~100。 默认值：10。

  • NextToken: —

    查询返回结果下一页的令牌。首次调用 API 不需要NextToken。 当您首次调用 API 时，如果返回数据总条数超过MaxResults限制，数据会被截断，只返回MaxResults条数据，同时，返回参数IsTruncated为true，返回一个NextToken。您可以使用上一次返回的NextToken继续调用 API，其他请求参数保持不变，查询被截断的数据。您可以按此方法经过多次查询，直到IsTruncated为false时，表示全部数据查询完毕。

  • FilterGroups: —

    筛选的用户组，该用户组关联的子用户会返回IsSelected=1

  • SortField: —

    排序的字段，目前只支持CreateTime，默认是CreateTime字段

  • SortType: —

    排序类型：Desc 倒序 Asc 正序，需要您和SortField一起设置

  • Offset: —

    翻页offset. 不要与NextToken同时使用，优先使用NextToken



5615
5616
5617
 
# File 'lib/v20210331/models.rb', line 5615

def Offset
  @Offset
end

#SortField ⇒ Object

Parameters:

  • ZoneId: —

    空间 ID。

  • UserStatus: —

    用户状态 Enabled：启用， Disabled：禁用。

  • UserType: —

    用户类型 Manual：手动创建，Synchronized：外部导入。

  • Filter: —

    过滤条件。 目前仅支持用户名，邮箱，用户userId，描述

  • MaxResults: —

    每页的最大数据条数。 取值范围：1~100。 默认值：10。

  • NextToken: —

    查询返回结果下一页的令牌。首次调用 API 不需要NextToken。 当您首次调用 API 时，如果返回数据总条数超过MaxResults限制，数据会被截断，只返回MaxResults条数据，同时，返回参数IsTruncated为true，返回一个NextToken。您可以使用上一次返回的NextToken继续调用 API，其他请求参数保持不变，查询被截断的数据。您可以按此方法经过多次查询，直到IsTruncated为false时，表示全部数据查询完毕。

  • FilterGroups: —

    筛选的用户组，该用户组关联的子用户会返回IsSelected=1

  • SortField: —

    排序的字段，目前只支持CreateTime，默认是CreateTime字段

  • SortType: —

    排序类型：Desc 倒序 Asc 正序，需要您和SortField一起设置

  • Offset: —

    翻页offset. 不要与NextToken同时使用，优先使用NextToken



5615
5616
5617
 
# File 'lib/v20210331/models.rb', line 5615

def SortField
  @SortField
end

#SortType ⇒ Object

Parameters:

  • ZoneId: —

    空间 ID。

  • UserStatus: —

    用户状态 Enabled：启用， Disabled：禁用。

  • UserType: —

    用户类型 Manual：手动创建，Synchronized：外部导入。

  • Filter: —

    过滤条件。 目前仅支持用户名，邮箱，用户userId，描述

  • MaxResults: —

    每页的最大数据条数。 取值范围：1~100。 默认值：10。

  • NextToken: —

    查询返回结果下一页的令牌。首次调用 API 不需要NextToken。 当您首次调用 API 时，如果返回数据总条数超过MaxResults限制，数据会被截断，只返回MaxResults条数据，同时，返回参数IsTruncated为true，返回一个NextToken。您可以使用上一次返回的NextToken继续调用 API，其他请求参数保持不变，查询被截断的数据。您可以按此方法经过多次查询，直到IsTruncated为false时，表示全部数据查询完毕。

  • FilterGroups: —

    筛选的用户组，该用户组关联的子用户会返回IsSelected=1

  • SortField: —

    排序的字段，目前只支持CreateTime，默认是CreateTime字段

  • SortType: —

    排序类型：Desc 倒序 Asc 正序，需要您和SortField一起设置

  • Offset: —

    翻页offset. 不要与NextToken同时使用，优先使用NextToken



5615
5616
5617
 
# File 'lib/v20210331/models.rb', line 5615

def SortType
  @SortType
end

#UserStatus ⇒ Object

Parameters:

  • ZoneId: —

    空间 ID。

  • UserStatus: —

    用户状态 Enabled：启用， Disabled：禁用。

  • UserType: —

    用户类型 Manual：手动创建，Synchronized：外部导入。

  • Filter: —

    过滤条件。 目前仅支持用户名，邮箱，用户userId，描述

  • MaxResults: —

    每页的最大数据条数。 取值范围：1~100。 默认值：10。

  • NextToken: —

    查询返回结果下一页的令牌。首次调用 API 不需要NextToken。 当您首次调用 API 时，如果返回数据总条数超过MaxResults限制，数据会被截断，只返回MaxResults条数据，同时，返回参数IsTruncated为true，返回一个NextToken。您可以使用上一次返回的NextToken继续调用 API，其他请求参数保持不变，查询被截断的数据。您可以按此方法经过多次查询，直到IsTruncated为false时，表示全部数据查询完毕。

  • FilterGroups: —

    筛选的用户组，该用户组关联的子用户会返回IsSelected=1

  • SortField: —

    排序的字段，目前只支持CreateTime，默认是CreateTime字段

  • SortType: —

    排序类型：Desc 倒序 Asc 正序，需要您和SortField一起设置

  • Offset: —

    翻页offset. 不要与NextToken同时使用，优先使用NextToken



5615
5616
5617
 
# File 'lib/v20210331/models.rb', line 5615

def UserStatus
  @UserStatus
end

#UserType ⇒ Object

Parameters:

  • ZoneId: —

    空间 ID。

  • UserStatus: —

    用户状态 Enabled：启用， Disabled：禁用。

  • UserType: —

    用户类型 Manual：手动创建，Synchronized：外部导入。

  • Filter: —

    过滤条件。 目前仅支持用户名，邮箱，用户userId，描述

  • MaxResults: —

    每页的最大数据条数。 取值范围：1~100。 默认值：10。

  • NextToken: —

    查询返回结果下一页的令牌。首次调用 API 不需要NextToken。 当您首次调用 API 时，如果返回数据总条数超过MaxResults限制，数据会被截断，只返回MaxResults条数据，同时，返回参数IsTruncated为true，返回一个NextToken。您可以使用上一次返回的NextToken继续调用 API，其他请求参数保持不变，查询被截断的数据。您可以按此方法经过多次查询，直到IsTruncated为false时，表示全部数据查询完毕。

  • FilterGroups: —

    筛选的用户组，该用户组关联的子用户会返回IsSelected=1

  • SortField: —

    排序的字段，目前只支持CreateTime，默认是CreateTime字段

  • SortType: —

    排序类型：Desc 倒序 Asc 正序，需要您和SortField一起设置

  • Offset: —

    翻页offset. 不要与NextToken同时使用，优先使用NextToken



5615
5616
5617
 
# File 'lib/v20210331/models.rb', line 5615

def UserType
  @UserType
end

#ZoneId ⇒ Object

Parameters:

  • ZoneId: —

    空间 ID。

  • UserStatus: —

    用户状态 Enabled：启用， Disabled：禁用。

  • UserType: —

    用户类型 Manual：手动创建，Synchronized：外部导入。

  • Filter: —

    过滤条件。 目前仅支持用户名，邮箱，用户userId，描述

  • MaxResults: —

    每页的最大数据条数。 取值范围：1~100。 默认值：10。

  • NextToken: —

    查询返回结果下一页的令牌。首次调用 API 不需要NextToken。 当您首次调用 API 时，如果返回数据总条数超过MaxResults限制，数据会被截断，只返回MaxResults条数据，同时，返回参数IsTruncated为true，返回一个NextToken。您可以使用上一次返回的NextToken继续调用 API，其他请求参数保持不变，查询被截断的数据。您可以按此方法经过多次查询，直到IsTruncated为false时，表示全部数据查询完毕。

  • FilterGroups: —

    筛选的用户组，该用户组关联的子用户会返回IsSelected=1

  • SortField: —

    排序的字段，目前只支持CreateTime，默认是CreateTime字段

  • SortType: —

    排序类型：Desc 倒序 Asc 正序，需要您和SortField一起设置

  • Offset: —

    翻页offset. 不要与NextToken同时使用，优先使用NextToken



5615
5616
5617
 
# File 'lib/v20210331/models.rb', line 5615

def ZoneId
  @ZoneId
end

Instance Method Details

#deserialize(params) ⇒ Object 



5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
 
# File 'lib/v20210331/models.rb', line 5630

def deserialize(params)
  @ZoneId = params['ZoneId']
  @UserStatus = params['UserStatus']
  @UserType = params['UserType']
  @Filter = params['Filter']
  @MaxResults = params['MaxResults']
  @NextToken = params['NextToken']
  @FilterGroups = params['FilterGroups']
  @SortField = params['SortField']
  @SortType = params['SortType']
  @Offset = params['Offset']
end