Class: TencentCloud::Ssm::V20190923::ListSecretsRequest

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

Overview

ListSecrets请求参数结构体

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(offset = nil, limit = nil, ordertype = nil, state = nil, searchsecretname = nil, tagfilters = nil, secrettype = nil, productname = nil) ⇒ ListSecretsRequest

Returns a new instance of ListSecretsRequest.



1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
 
# File 'lib/v20190923/models.rb', line 1052

def initialize(offset=nil, limit=nil, ordertype=nil, state=nil, searchsecretname=nil, tagfilters=nil, secrettype=nil, productname=nil)
  @Offset = offset
  @Limit = limit
  @OrderType = ordertype
  @State = state
  @SearchSecretName = searchsecretname
  @TagFilters = tagfilters
  @SecretType = secrettype
  @ProductName = productname
end

Instance Attribute Details

#Limit ⇒ Object

默认为0表示查询全部。1 – 表示查询Enabled 凭据列表。2 – 表示查询Disabled 凭据列表。3 – 表示查询PendingDelete 凭据列表。4 – 表示PendingCreate。5 – 表示CreateFailed。其中状态PendingCreate和CreateFailed只有在SecretType为云产品凭据时生效1 – 表示用户云产品凭据。2 – 表示SSH密钥对凭据。3 – 表示云API密钥对凭据。当SecretType值为1时：如果ProductName值为空，则表示查询所有类型的云产品凭据；如果ProductName值为某个指定的云产品值如Mysql时，则表示查询Mysql数据库凭据；如果ProductName值为多个云产品值，如：Mysql,Tdsql-mysql,Tdsql_C_Mysql（多个值以英文逗号,分隔开）则表示查询三种云产品类型的凭据；支持的云产品列表请通过接口：DescribeSupportedProducts进行查询。

Parameters:

  • Offset: —

    查询列表的起始位置，以0开始，不设置默认为0。

  • Limit: —

    单次查询返回的最大数量，0或不设置则使用默认值 20。

  • OrderType: —

    根据创建时间的排序方式，0或者不设置则使用降序排序， 1 表示升序排序。

  • State: —

    根据凭据状态进行过滤。

  • SearchSecretName: —

    根据凭据名称进行过滤，为空表示不过滤。

  • TagFilters: —

    标签过滤条件。

  • SecretType: —

    0 – 表示用户自定义凭据，默认为0。

  • ProductName: —

    此参数仅在SecretType参数值为1时生效，



1050
1051
1052
 
# File 'lib/v20190923/models.rb', line 1050

def Limit
  @Limit
end

#Offset ⇒ Object

默认为0表示查询全部。1 – 表示查询Enabled 凭据列表。2 – 表示查询Disabled 凭据列表。3 – 表示查询PendingDelete 凭据列表。4 – 表示PendingCreate。5 – 表示CreateFailed。其中状态PendingCreate和CreateFailed只有在SecretType为云产品凭据时生效1 – 表示用户云产品凭据。2 – 表示SSH密钥对凭据。3 – 表示云API密钥对凭据。当SecretType值为1时：如果ProductName值为空，则表示查询所有类型的云产品凭据；如果ProductName值为某个指定的云产品值如Mysql时，则表示查询Mysql数据库凭据；如果ProductName值为多个云产品值，如：Mysql,Tdsql-mysql,Tdsql_C_Mysql（多个值以英文逗号,分隔开）则表示查询三种云产品类型的凭据；支持的云产品列表请通过接口：DescribeSupportedProducts进行查询。

Parameters:

  • Offset: —

    查询列表的起始位置，以0开始，不设置默认为0。

  • Limit: —

    单次查询返回的最大数量，0或不设置则使用默认值 20。

  • OrderType: —

    根据创建时间的排序方式，0或者不设置则使用降序排序， 1 表示升序排序。

  • State: —

    根据凭据状态进行过滤。

  • SearchSecretName: —

    根据凭据名称进行过滤，为空表示不过滤。

  • TagFilters: —

    标签过滤条件。

  • SecretType: —

    0 – 表示用户自定义凭据，默认为0。

  • ProductName: —

    此参数仅在SecretType参数值为1时生效，



1050
1051
1052
 
# File 'lib/v20190923/models.rb', line 1050

def Offset
  @Offset
end

#OrderType ⇒ Object

默认为0表示查询全部。1 – 表示查询Enabled 凭据列表。2 – 表示查询Disabled 凭据列表。3 – 表示查询PendingDelete 凭据列表。4 – 表示PendingCreate。5 – 表示CreateFailed。其中状态PendingCreate和CreateFailed只有在SecretType为云产品凭据时生效1 – 表示用户云产品凭据。2 – 表示SSH密钥对凭据。3 – 表示云API密钥对凭据。当SecretType值为1时：如果ProductName值为空，则表示查询所有类型的云产品凭据；如果ProductName值为某个指定的云产品值如Mysql时，则表示查询Mysql数据库凭据；如果ProductName值为多个云产品值，如：Mysql,Tdsql-mysql,Tdsql_C_Mysql（多个值以英文逗号,分隔开）则表示查询三种云产品类型的凭据；支持的云产品列表请通过接口：DescribeSupportedProducts进行查询。

Parameters:

  • Offset: —

    查询列表的起始位置，以0开始，不设置默认为0。

  • Limit: —

    单次查询返回的最大数量，0或不设置则使用默认值 20。

  • OrderType: —

    根据创建时间的排序方式，0或者不设置则使用降序排序， 1 表示升序排序。

  • State: —

    根据凭据状态进行过滤。

  • SearchSecretName: —

    根据凭据名称进行过滤，为空表示不过滤。

  • TagFilters: —

    标签过滤条件。

  • SecretType: —

    0 – 表示用户自定义凭据，默认为0。

  • ProductName: —

    此参数仅在SecretType参数值为1时生效，



1050
1051
1052
 
# File 'lib/v20190923/models.rb', line 1050

def OrderType
  @OrderType
end

#ProductName ⇒ Object

默认为0表示查询全部。1 – 表示查询Enabled 凭据列表。2 – 表示查询Disabled 凭据列表。3 – 表示查询PendingDelete 凭据列表。4 – 表示PendingCreate。5 – 表示CreateFailed。其中状态PendingCreate和CreateFailed只有在SecretType为云产品凭据时生效1 – 表示用户云产品凭据。2 – 表示SSH密钥对凭据。3 – 表示云API密钥对凭据。当SecretType值为1时：如果ProductName值为空，则表示查询所有类型的云产品凭据；如果ProductName值为某个指定的云产品值如Mysql时，则表示查询Mysql数据库凭据；如果ProductName值为多个云产品值，如：Mysql,Tdsql-mysql,Tdsql_C_Mysql（多个值以英文逗号,分隔开）则表示查询三种云产品类型的凭据；支持的云产品列表请通过接口：DescribeSupportedProducts进行查询。

Parameters:

  • Offset: —

    查询列表的起始位置，以0开始，不设置默认为0。

  • Limit: —

    单次查询返回的最大数量，0或不设置则使用默认值 20。

  • OrderType: —

    根据创建时间的排序方式，0或者不设置则使用降序排序， 1 表示升序排序。

  • State: —

    根据凭据状态进行过滤。

  • SearchSecretName: —

    根据凭据名称进行过滤，为空表示不过滤。

  • TagFilters: —

    标签过滤条件。

  • SecretType: —

    0 – 表示用户自定义凭据，默认为0。

  • ProductName: —

    此参数仅在SecretType参数值为1时生效，



1050
1051
1052
 
# File 'lib/v20190923/models.rb', line 1050

def ProductName
  @ProductName
end

#SearchSecretName ⇒ Object

默认为0表示查询全部。1 – 表示查询Enabled 凭据列表。2 – 表示查询Disabled 凭据列表。3 – 表示查询PendingDelete 凭据列表。4 – 表示PendingCreate。5 – 表示CreateFailed。其中状态PendingCreate和CreateFailed只有在SecretType为云产品凭据时生效1 – 表示用户云产品凭据。2 – 表示SSH密钥对凭据。3 – 表示云API密钥对凭据。当SecretType值为1时：如果ProductName值为空，则表示查询所有类型的云产品凭据；如果ProductName值为某个指定的云产品值如Mysql时，则表示查询Mysql数据库凭据；如果ProductName值为多个云产品值，如：Mysql,Tdsql-mysql,Tdsql_C_Mysql（多个值以英文逗号,分隔开）则表示查询三种云产品类型的凭据；支持的云产品列表请通过接口：DescribeSupportedProducts进行查询。

Parameters:

  • Offset: —

    查询列表的起始位置，以0开始，不设置默认为0。

  • Limit: —

    单次查询返回的最大数量，0或不设置则使用默认值 20。

  • OrderType: —

    根据创建时间的排序方式，0或者不设置则使用降序排序， 1 表示升序排序。

  • State: —

    根据凭据状态进行过滤。

  • SearchSecretName: —

    根据凭据名称进行过滤，为空表示不过滤。

  • TagFilters: —

    标签过滤条件。

  • SecretType: —

    0 – 表示用户自定义凭据，默认为0。

  • ProductName: —

    此参数仅在SecretType参数值为1时生效，



1050
1051
1052
 
# File 'lib/v20190923/models.rb', line 1050

def SearchSecretName
  @SearchSecretName
end

#SecretType ⇒ Object

默认为0表示查询全部。1 – 表示查询Enabled 凭据列表。2 – 表示查询Disabled 凭据列表。3 – 表示查询PendingDelete 凭据列表。4 – 表示PendingCreate。5 – 表示CreateFailed。其中状态PendingCreate和CreateFailed只有在SecretType为云产品凭据时生效1 – 表示用户云产品凭据。2 – 表示SSH密钥对凭据。3 – 表示云API密钥对凭据。当SecretType值为1时：如果ProductName值为空，则表示查询所有类型的云产品凭据；如果ProductName值为某个指定的云产品值如Mysql时，则表示查询Mysql数据库凭据；如果ProductName值为多个云产品值，如：Mysql,Tdsql-mysql,Tdsql_C_Mysql（多个值以英文逗号,分隔开）则表示查询三种云产品类型的凭据；支持的云产品列表请通过接口：DescribeSupportedProducts进行查询。

Parameters:

  • Offset: —

    查询列表的起始位置，以0开始，不设置默认为0。

  • Limit: —

    单次查询返回的最大数量，0或不设置则使用默认值 20。

  • OrderType: —

    根据创建时间的排序方式，0或者不设置则使用降序排序， 1 表示升序排序。

  • State: —

    根据凭据状态进行过滤。

  • SearchSecretName: —

    根据凭据名称进行过滤，为空表示不过滤。

  • TagFilters: —

    标签过滤条件。

  • SecretType: —

    0 – 表示用户自定义凭据，默认为0。

  • ProductName: —

    此参数仅在SecretType参数值为1时生效，



1050
1051
1052
 
# File 'lib/v20190923/models.rb', line 1050

def SecretType
  @SecretType
end

#State ⇒ Object

默认为0表示查询全部。1 – 表示查询Enabled 凭据列表。2 – 表示查询Disabled 凭据列表。3 – 表示查询PendingDelete 凭据列表。4 – 表示PendingCreate。5 – 表示CreateFailed。其中状态PendingCreate和CreateFailed只有在SecretType为云产品凭据时生效1 – 表示用户云产品凭据。2 – 表示SSH密钥对凭据。3 – 表示云API密钥对凭据。当SecretType值为1时：如果ProductName值为空，则表示查询所有类型的云产品凭据；如果ProductName值为某个指定的云产品值如Mysql时，则表示查询Mysql数据库凭据；如果ProductName值为多个云产品值，如：Mysql,Tdsql-mysql,Tdsql_C_Mysql（多个值以英文逗号,分隔开）则表示查询三种云产品类型的凭据；支持的云产品列表请通过接口：DescribeSupportedProducts进行查询。

Parameters:

  • Offset: —

    查询列表的起始位置，以0开始，不设置默认为0。

  • Limit: —

    单次查询返回的最大数量，0或不设置则使用默认值 20。

  • OrderType: —

    根据创建时间的排序方式，0或者不设置则使用降序排序， 1 表示升序排序。

  • State: —

    根据凭据状态进行过滤。

  • SearchSecretName: —

    根据凭据名称进行过滤，为空表示不过滤。

  • TagFilters: —

    标签过滤条件。

  • SecretType: —

    0 – 表示用户自定义凭据，默认为0。

  • ProductName: —

    此参数仅在SecretType参数值为1时生效，



1050
1051
1052
 
# File 'lib/v20190923/models.rb', line 1050

def State
  @State
end

#TagFilters ⇒ Object

默认为0表示查询全部。1 – 表示查询Enabled 凭据列表。2 – 表示查询Disabled 凭据列表。3 – 表示查询PendingDelete 凭据列表。4 – 表示PendingCreate。5 – 表示CreateFailed。其中状态PendingCreate和CreateFailed只有在SecretType为云产品凭据时生效1 – 表示用户云产品凭据。2 – 表示SSH密钥对凭据。3 – 表示云API密钥对凭据。当SecretType值为1时：如果ProductName值为空，则表示查询所有类型的云产品凭据；如果ProductName值为某个指定的云产品值如Mysql时，则表示查询Mysql数据库凭据；如果ProductName值为多个云产品值，如：Mysql,Tdsql-mysql,Tdsql_C_Mysql（多个值以英文逗号,分隔开）则表示查询三种云产品类型的凭据；支持的云产品列表请通过接口：DescribeSupportedProducts进行查询。

Parameters:

  • Offset: —

    查询列表的起始位置，以0开始，不设置默认为0。

  • Limit: —

    单次查询返回的最大数量，0或不设置则使用默认值 20。

  • OrderType: —

    根据创建时间的排序方式，0或者不设置则使用降序排序， 1 表示升序排序。

  • State: —

    根据凭据状态进行过滤。

  • SearchSecretName: —

    根据凭据名称进行过滤，为空表示不过滤。

  • TagFilters: —

    标签过滤条件。

  • SecretType: —

    0 – 表示用户自定义凭据，默认为0。

  • ProductName: —

    此参数仅在SecretType参数值为1时生效，



1050
1051
1052
 
# File 'lib/v20190923/models.rb', line 1050

def TagFilters
  @TagFilters
end

Instance Method Details

#deserialize(params) ⇒ Object 



1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
 
# File 'lib/v20190923/models.rb', line 1063

def deserialize(params)
  @Offset = params['Offset']
  @Limit = params['Limit']
  @OrderType = params['OrderType']
  @State = params['State']
  @SearchSecretName = params['SearchSecretName']
  unless params['TagFilters'].nil?
    @TagFilters = []
    params['TagFilters'].each do |i|
      tagfilter_tmp = TagFilter.new
      tagfilter_tmp.deserialize(i)
      @TagFilters << tagfilter_tmp
    end
  end
  @SecretType = params['SecretType']
  @ProductName = params['ProductName']
end