Class: TencentCloud::Kms::V20190118::ListKeyDetailRequest

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

Overview

ListKeyDetail请求参数结构体

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(offset = nil, limit = nil, role = nil, ordertype = nil, keystate = nil, searchkeyalias = nil, origin = nil, keyusage = nil, tagfilters = nil, hsmclusterid = nil) ⇒ ListKeyDetailRequest

Returns a new instance of ListKeyDetailRequest.



1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
 
# File 'lib/v20190118/models.rb', line 1866

def initialize(offset=nil, limit=nil, role=nil, ordertype=nil, keystate=nil, searchkeyalias=nil, origin=nil, keyusage=nil, tagfilters=nil, hsmclusterid=nil)
  @Offset = offset
  @Limit = limit
  @Role = role
  @OrderType = ordertype
  @KeyState = keystate
  @SearchKeyAlias = searchkeyalias
  @Origin = origin
  @KeyUsage = keyusage
  @TagFilters = tagfilters
  @HsmClusterId = hsmclusterid
end

Instance Attribute Details

#HsmClusterId ⇒ Object

Parameters:

  • Offset: —

    含义跟 SQL 查询的 Offset 一致，表示本次获取从按一定顺序排列数组的第 Offset 个元素开始，缺省为0

  • Limit: —

    含义跟 SQL 查询的 Limit 一致，表示本次最多获取 Limit 个元素。缺省值为10，最大值为200

  • Role: —

    根据创建者角色筛选，默认 0 表示用户自己创建的cmk， 1 表示授权其它云产品自动创建的cmk

  • OrderType: —

    根据CMK创建时间排序， 0 表示按照降序排序，1表示按照升序排序

  • KeyState: —

    根据CMK状态筛选， 0表示全部CMK， 1 表示仅查询Enabled CMK， 2 表示仅查询Disabled CMK，3 表示查询PendingDelete 状态的CMK(处于计划删除状态的Key)，4 表示查询 PendingImport 状态的CMK，5 表示查询 Archived 状态的 CMK

  • SearchKeyAlias: —

    根据KeyId或者Alias进行模糊匹配查询

  • Origin: —

    根据CMK类型筛选， “TENCENT_KMS” 表示筛选密钥材料由KMS创建的CMK， “EXTERNAL” 表示筛选密钥材料需要用户导入的 EXTERNAL类型CMK，“ALL” 或者不设置表示两种类型都查询，大小写敏感。

  • KeyUsage: —

    根据CMK的KeyUsage筛选，ALL表示筛选全部，可使用的参数为：ALL 或 ENCRYPT_DECRYPT 或 ASYMMETRIC_DECRYPT_RSA_2048 或 ASYMMETRIC_DECRYPT_SM2 或 ASYMMETRIC_SIGN_VERIFY_SM2 或 ASYMMETRIC_SIGN_VERIFY_RSA_2048 或 ASYMMETRIC_SIGN_VERIFY_ECC，为空则默认筛选ENCRYPT_DECRYPT类型

  • TagFilters: —

    标签过滤条件

  • HsmClusterId: —

    KMS 高级版对应的 HSM 集群 ID（仅对 KMS 独占版/托管版服务实例有效）。



1864
1865
1866
 
# File 'lib/v20190118/models.rb', line 1864

def HsmClusterId
  @HsmClusterId
end

#KeyState ⇒ Object

Parameters:

  • Offset: —

    含义跟 SQL 查询的 Offset 一致，表示本次获取从按一定顺序排列数组的第 Offset 个元素开始，缺省为0

  • Limit: —

    含义跟 SQL 查询的 Limit 一致，表示本次最多获取 Limit 个元素。缺省值为10，最大值为200

  • Role: —

    根据创建者角色筛选，默认 0 表示用户自己创建的cmk， 1 表示授权其它云产品自动创建的cmk

  • OrderType: —

    根据CMK创建时间排序， 0 表示按照降序排序，1表示按照升序排序

  • KeyState: —

    根据CMK状态筛选， 0表示全部CMK， 1 表示仅查询Enabled CMK， 2 表示仅查询Disabled CMK，3 表示查询PendingDelete 状态的CMK(处于计划删除状态的Key)，4 表示查询 PendingImport 状态的CMK，5 表示查询 Archived 状态的 CMK

  • SearchKeyAlias: —

    根据KeyId或者Alias进行模糊匹配查询

  • Origin: —

    根据CMK类型筛选， “TENCENT_KMS” 表示筛选密钥材料由KMS创建的CMK， “EXTERNAL” 表示筛选密钥材料需要用户导入的 EXTERNAL类型CMK，“ALL” 或者不设置表示两种类型都查询，大小写敏感。

  • KeyUsage: —

    根据CMK的KeyUsage筛选，ALL表示筛选全部，可使用的参数为：ALL 或 ENCRYPT_DECRYPT 或 ASYMMETRIC_DECRYPT_RSA_2048 或 ASYMMETRIC_DECRYPT_SM2 或 ASYMMETRIC_SIGN_VERIFY_SM2 或 ASYMMETRIC_SIGN_VERIFY_RSA_2048 或 ASYMMETRIC_SIGN_VERIFY_ECC，为空则默认筛选ENCRYPT_DECRYPT类型

  • TagFilters: —

    标签过滤条件

  • HsmClusterId: —

    KMS 高级版对应的 HSM 集群 ID（仅对 KMS 独占版/托管版服务实例有效）。



1864
1865
1866
 
# File 'lib/v20190118/models.rb', line 1864

def KeyState
  @KeyState
end

#KeyUsage ⇒ Object

Parameters:

  • Offset: —

    含义跟 SQL 查询的 Offset 一致，表示本次获取从按一定顺序排列数组的第 Offset 个元素开始，缺省为0

  • Limit: —

    含义跟 SQL 查询的 Limit 一致，表示本次最多获取 Limit 个元素。缺省值为10，最大值为200

  • Role: —

    根据创建者角色筛选，默认 0 表示用户自己创建的cmk， 1 表示授权其它云产品自动创建的cmk

  • OrderType: —

    根据CMK创建时间排序， 0 表示按照降序排序，1表示按照升序排序

  • KeyState: —

    根据CMK状态筛选， 0表示全部CMK， 1 表示仅查询Enabled CMK， 2 表示仅查询Disabled CMK，3 表示查询PendingDelete 状态的CMK(处于计划删除状态的Key)，4 表示查询 PendingImport 状态的CMK，5 表示查询 Archived 状态的 CMK

  • SearchKeyAlias: —

    根据KeyId或者Alias进行模糊匹配查询

  • Origin: —

    根据CMK类型筛选， “TENCENT_KMS” 表示筛选密钥材料由KMS创建的CMK， “EXTERNAL” 表示筛选密钥材料需要用户导入的 EXTERNAL类型CMK，“ALL” 或者不设置表示两种类型都查询，大小写敏感。

  • KeyUsage: —

    根据CMK的KeyUsage筛选，ALL表示筛选全部，可使用的参数为：ALL 或 ENCRYPT_DECRYPT 或 ASYMMETRIC_DECRYPT_RSA_2048 或 ASYMMETRIC_DECRYPT_SM2 或 ASYMMETRIC_SIGN_VERIFY_SM2 或 ASYMMETRIC_SIGN_VERIFY_RSA_2048 或 ASYMMETRIC_SIGN_VERIFY_ECC，为空则默认筛选ENCRYPT_DECRYPT类型

  • TagFilters: —

    标签过滤条件

  • HsmClusterId: —

    KMS 高级版对应的 HSM 集群 ID（仅对 KMS 独占版/托管版服务实例有效）。



1864
1865
1866
 
# File 'lib/v20190118/models.rb', line 1864

def KeyUsage
  @KeyUsage
end

#Limit ⇒ Object

Parameters:

  • Offset: —

    含义跟 SQL 查询的 Offset 一致，表示本次获取从按一定顺序排列数组的第 Offset 个元素开始，缺省为0

  • Limit: —

    含义跟 SQL 查询的 Limit 一致，表示本次最多获取 Limit 个元素。缺省值为10，最大值为200

  • Role: —

    根据创建者角色筛选，默认 0 表示用户自己创建的cmk， 1 表示授权其它云产品自动创建的cmk

  • OrderType: —

    根据CMK创建时间排序， 0 表示按照降序排序，1表示按照升序排序

  • KeyState: —

    根据CMK状态筛选， 0表示全部CMK， 1 表示仅查询Enabled CMK， 2 表示仅查询Disabled CMK，3 表示查询PendingDelete 状态的CMK(处于计划删除状态的Key)，4 表示查询 PendingImport 状态的CMK，5 表示查询 Archived 状态的 CMK

  • SearchKeyAlias: —

    根据KeyId或者Alias进行模糊匹配查询

  • Origin: —

    根据CMK类型筛选， “TENCENT_KMS” 表示筛选密钥材料由KMS创建的CMK， “EXTERNAL” 表示筛选密钥材料需要用户导入的 EXTERNAL类型CMK，“ALL” 或者不设置表示两种类型都查询，大小写敏感。

  • KeyUsage: —

    根据CMK的KeyUsage筛选，ALL表示筛选全部，可使用的参数为：ALL 或 ENCRYPT_DECRYPT 或 ASYMMETRIC_DECRYPT_RSA_2048 或 ASYMMETRIC_DECRYPT_SM2 或 ASYMMETRIC_SIGN_VERIFY_SM2 或 ASYMMETRIC_SIGN_VERIFY_RSA_2048 或 ASYMMETRIC_SIGN_VERIFY_ECC，为空则默认筛选ENCRYPT_DECRYPT类型

  • TagFilters: —

    标签过滤条件

  • HsmClusterId: —

    KMS 高级版对应的 HSM 集群 ID（仅对 KMS 独占版/托管版服务实例有效）。



1864
1865
1866
 
# File 'lib/v20190118/models.rb', line 1864

def Limit
  @Limit
end

#Offset ⇒ Object

Parameters:

  • Offset: —

    含义跟 SQL 查询的 Offset 一致，表示本次获取从按一定顺序排列数组的第 Offset 个元素开始，缺省为0

  • Limit: —

    含义跟 SQL 查询的 Limit 一致，表示本次最多获取 Limit 个元素。缺省值为10，最大值为200

  • Role: —

    根据创建者角色筛选，默认 0 表示用户自己创建的cmk， 1 表示授权其它云产品自动创建的cmk

  • OrderType: —

    根据CMK创建时间排序， 0 表示按照降序排序，1表示按照升序排序

  • KeyState: —

    根据CMK状态筛选， 0表示全部CMK， 1 表示仅查询Enabled CMK， 2 表示仅查询Disabled CMK，3 表示查询PendingDelete 状态的CMK(处于计划删除状态的Key)，4 表示查询 PendingImport 状态的CMK，5 表示查询 Archived 状态的 CMK

  • SearchKeyAlias: —

    根据KeyId或者Alias进行模糊匹配查询

  • Origin: —

    根据CMK类型筛选， “TENCENT_KMS” 表示筛选密钥材料由KMS创建的CMK， “EXTERNAL” 表示筛选密钥材料需要用户导入的 EXTERNAL类型CMK，“ALL” 或者不设置表示两种类型都查询，大小写敏感。

  • KeyUsage: —

    根据CMK的KeyUsage筛选，ALL表示筛选全部，可使用的参数为：ALL 或 ENCRYPT_DECRYPT 或 ASYMMETRIC_DECRYPT_RSA_2048 或 ASYMMETRIC_DECRYPT_SM2 或 ASYMMETRIC_SIGN_VERIFY_SM2 或 ASYMMETRIC_SIGN_VERIFY_RSA_2048 或 ASYMMETRIC_SIGN_VERIFY_ECC，为空则默认筛选ENCRYPT_DECRYPT类型

  • TagFilters: —

    标签过滤条件

  • HsmClusterId: —

    KMS 高级版对应的 HSM 集群 ID（仅对 KMS 独占版/托管版服务实例有效）。



1864
1865
1866
 
# File 'lib/v20190118/models.rb', line 1864

def Offset
  @Offset
end

#OrderType ⇒ Object

Parameters:

  • Offset: —

    含义跟 SQL 查询的 Offset 一致，表示本次获取从按一定顺序排列数组的第 Offset 个元素开始，缺省为0

  • Limit: —

    含义跟 SQL 查询的 Limit 一致，表示本次最多获取 Limit 个元素。缺省值为10，最大值为200

  • Role: —

    根据创建者角色筛选，默认 0 表示用户自己创建的cmk， 1 表示授权其它云产品自动创建的cmk

  • OrderType: —

    根据CMK创建时间排序， 0 表示按照降序排序，1表示按照升序排序

  • KeyState: —

    根据CMK状态筛选， 0表示全部CMK， 1 表示仅查询Enabled CMK， 2 表示仅查询Disabled CMK，3 表示查询PendingDelete 状态的CMK(处于计划删除状态的Key)，4 表示查询 PendingImport 状态的CMK，5 表示查询 Archived 状态的 CMK

  • SearchKeyAlias: —

    根据KeyId或者Alias进行模糊匹配查询

  • Origin: —

    根据CMK类型筛选， “TENCENT_KMS” 表示筛选密钥材料由KMS创建的CMK， “EXTERNAL” 表示筛选密钥材料需要用户导入的 EXTERNAL类型CMK，“ALL” 或者不设置表示两种类型都查询，大小写敏感。

  • KeyUsage: —

    根据CMK的KeyUsage筛选，ALL表示筛选全部，可使用的参数为：ALL 或 ENCRYPT_DECRYPT 或 ASYMMETRIC_DECRYPT_RSA_2048 或 ASYMMETRIC_DECRYPT_SM2 或 ASYMMETRIC_SIGN_VERIFY_SM2 或 ASYMMETRIC_SIGN_VERIFY_RSA_2048 或 ASYMMETRIC_SIGN_VERIFY_ECC，为空则默认筛选ENCRYPT_DECRYPT类型

  • TagFilters: —

    标签过滤条件

  • HsmClusterId: —

    KMS 高级版对应的 HSM 集群 ID（仅对 KMS 独占版/托管版服务实例有效）。



1864
1865
1866
 
# File 'lib/v20190118/models.rb', line 1864

def OrderType
  @OrderType
end

#Origin ⇒ Object

Parameters:

  • Offset: —

    含义跟 SQL 查询的 Offset 一致，表示本次获取从按一定顺序排列数组的第 Offset 个元素开始，缺省为0

  • Limit: —

    含义跟 SQL 查询的 Limit 一致，表示本次最多获取 Limit 个元素。缺省值为10，最大值为200

  • Role: —

    根据创建者角色筛选，默认 0 表示用户自己创建的cmk， 1 表示授权其它云产品自动创建的cmk

  • OrderType: —

    根据CMK创建时间排序， 0 表示按照降序排序，1表示按照升序排序

  • KeyState: —

    根据CMK状态筛选， 0表示全部CMK， 1 表示仅查询Enabled CMK， 2 表示仅查询Disabled CMK，3 表示查询PendingDelete 状态的CMK(处于计划删除状态的Key)，4 表示查询 PendingImport 状态的CMK，5 表示查询 Archived 状态的 CMK

  • SearchKeyAlias: —

    根据KeyId或者Alias进行模糊匹配查询

  • Origin: —

    根据CMK类型筛选， “TENCENT_KMS” 表示筛选密钥材料由KMS创建的CMK， “EXTERNAL” 表示筛选密钥材料需要用户导入的 EXTERNAL类型CMK，“ALL” 或者不设置表示两种类型都查询，大小写敏感。

  • KeyUsage: —

    根据CMK的KeyUsage筛选，ALL表示筛选全部，可使用的参数为：ALL 或 ENCRYPT_DECRYPT 或 ASYMMETRIC_DECRYPT_RSA_2048 或 ASYMMETRIC_DECRYPT_SM2 或 ASYMMETRIC_SIGN_VERIFY_SM2 或 ASYMMETRIC_SIGN_VERIFY_RSA_2048 或 ASYMMETRIC_SIGN_VERIFY_ECC，为空则默认筛选ENCRYPT_DECRYPT类型

  • TagFilters: —

    标签过滤条件

  • HsmClusterId: —

    KMS 高级版对应的 HSM 集群 ID（仅对 KMS 独占版/托管版服务实例有效）。



1864
1865
1866
 
# File 'lib/v20190118/models.rb', line 1864

def Origin
  @Origin
end

#Role ⇒ Object

Parameters:

  • Offset: —

    含义跟 SQL 查询的 Offset 一致，表示本次获取从按一定顺序排列数组的第 Offset 个元素开始，缺省为0

  • Limit: —

    含义跟 SQL 查询的 Limit 一致，表示本次最多获取 Limit 个元素。缺省值为10，最大值为200

  • Role: —

    根据创建者角色筛选，默认 0 表示用户自己创建的cmk， 1 表示授权其它云产品自动创建的cmk

  • OrderType: —

    根据CMK创建时间排序， 0 表示按照降序排序，1表示按照升序排序

  • KeyState: —

    根据CMK状态筛选， 0表示全部CMK， 1 表示仅查询Enabled CMK， 2 表示仅查询Disabled CMK，3 表示查询PendingDelete 状态的CMK(处于计划删除状态的Key)，4 表示查询 PendingImport 状态的CMK，5 表示查询 Archived 状态的 CMK

  • SearchKeyAlias: —

    根据KeyId或者Alias进行模糊匹配查询

  • Origin: —

    根据CMK类型筛选， “TENCENT_KMS” 表示筛选密钥材料由KMS创建的CMK， “EXTERNAL” 表示筛选密钥材料需要用户导入的 EXTERNAL类型CMK，“ALL” 或者不设置表示两种类型都查询，大小写敏感。

  • KeyUsage: —

    根据CMK的KeyUsage筛选，ALL表示筛选全部，可使用的参数为：ALL 或 ENCRYPT_DECRYPT 或 ASYMMETRIC_DECRYPT_RSA_2048 或 ASYMMETRIC_DECRYPT_SM2 或 ASYMMETRIC_SIGN_VERIFY_SM2 或 ASYMMETRIC_SIGN_VERIFY_RSA_2048 或 ASYMMETRIC_SIGN_VERIFY_ECC，为空则默认筛选ENCRYPT_DECRYPT类型

  • TagFilters: —

    标签过滤条件

  • HsmClusterId: —

    KMS 高级版对应的 HSM 集群 ID（仅对 KMS 独占版/托管版服务实例有效）。



1864
1865
1866
 
# File 'lib/v20190118/models.rb', line 1864

def Role
  @Role
end

#SearchKeyAlias ⇒ Object

Parameters:

  • Offset: —

    含义跟 SQL 查询的 Offset 一致，表示本次获取从按一定顺序排列数组的第 Offset 个元素开始，缺省为0

  • Limit: —

    含义跟 SQL 查询的 Limit 一致，表示本次最多获取 Limit 个元素。缺省值为10，最大值为200

  • Role: —

    根据创建者角色筛选，默认 0 表示用户自己创建的cmk， 1 表示授权其它云产品自动创建的cmk

  • OrderType: —

    根据CMK创建时间排序， 0 表示按照降序排序，1表示按照升序排序

  • KeyState: —

    根据CMK状态筛选， 0表示全部CMK， 1 表示仅查询Enabled CMK， 2 表示仅查询Disabled CMK，3 表示查询PendingDelete 状态的CMK(处于计划删除状态的Key)，4 表示查询 PendingImport 状态的CMK，5 表示查询 Archived 状态的 CMK

  • SearchKeyAlias: —

    根据KeyId或者Alias进行模糊匹配查询

  • Origin: —

    根据CMK类型筛选， “TENCENT_KMS” 表示筛选密钥材料由KMS创建的CMK， “EXTERNAL” 表示筛选密钥材料需要用户导入的 EXTERNAL类型CMK，“ALL” 或者不设置表示两种类型都查询，大小写敏感。

  • KeyUsage: —

    根据CMK的KeyUsage筛选，ALL表示筛选全部，可使用的参数为：ALL 或 ENCRYPT_DECRYPT 或 ASYMMETRIC_DECRYPT_RSA_2048 或 ASYMMETRIC_DECRYPT_SM2 或 ASYMMETRIC_SIGN_VERIFY_SM2 或 ASYMMETRIC_SIGN_VERIFY_RSA_2048 或 ASYMMETRIC_SIGN_VERIFY_ECC，为空则默认筛选ENCRYPT_DECRYPT类型

  • TagFilters: —

    标签过滤条件

  • HsmClusterId: —

    KMS 高级版对应的 HSM 集群 ID（仅对 KMS 独占版/托管版服务实例有效）。



1864
1865
1866
 
# File 'lib/v20190118/models.rb', line 1864

def SearchKeyAlias
  @SearchKeyAlias
end

#TagFilters ⇒ Object

Parameters:

  • Offset: —

    含义跟 SQL 查询的 Offset 一致，表示本次获取从按一定顺序排列数组的第 Offset 个元素开始，缺省为0

  • Limit: —

    含义跟 SQL 查询的 Limit 一致，表示本次最多获取 Limit 个元素。缺省值为10，最大值为200

  • Role: —

    根据创建者角色筛选，默认 0 表示用户自己创建的cmk， 1 表示授权其它云产品自动创建的cmk

  • OrderType: —

    根据CMK创建时间排序， 0 表示按照降序排序，1表示按照升序排序

  • KeyState: —

    根据CMK状态筛选， 0表示全部CMK， 1 表示仅查询Enabled CMK， 2 表示仅查询Disabled CMK，3 表示查询PendingDelete 状态的CMK(处于计划删除状态的Key)，4 表示查询 PendingImport 状态的CMK，5 表示查询 Archived 状态的 CMK

  • SearchKeyAlias: —

    根据KeyId或者Alias进行模糊匹配查询

  • Origin: —

    根据CMK类型筛选， “TENCENT_KMS” 表示筛选密钥材料由KMS创建的CMK， “EXTERNAL” 表示筛选密钥材料需要用户导入的 EXTERNAL类型CMK，“ALL” 或者不设置表示两种类型都查询，大小写敏感。

  • KeyUsage: —

    根据CMK的KeyUsage筛选，ALL表示筛选全部，可使用的参数为：ALL 或 ENCRYPT_DECRYPT 或 ASYMMETRIC_DECRYPT_RSA_2048 或 ASYMMETRIC_DECRYPT_SM2 或 ASYMMETRIC_SIGN_VERIFY_SM2 或 ASYMMETRIC_SIGN_VERIFY_RSA_2048 或 ASYMMETRIC_SIGN_VERIFY_ECC，为空则默认筛选ENCRYPT_DECRYPT类型

  • TagFilters: —

    标签过滤条件

  • HsmClusterId: —

    KMS 高级版对应的 HSM 集群 ID（仅对 KMS 独占版/托管版服务实例有效）。



1864
1865
1866
 
# File 'lib/v20190118/models.rb', line 1864

def TagFilters
  @TagFilters
end

Instance Method Details

#deserialize(params) ⇒ Object 



1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
 
# File 'lib/v20190118/models.rb', line 1879

def deserialize(params)
  @Offset = params['Offset']
  @Limit = params['Limit']
  @Role = params['Role']
  @OrderType = params['OrderType']
  @KeyState = params['KeyState']
  @SearchKeyAlias = params['SearchKeyAlias']
  @Origin = params['Origin']
  @KeyUsage = params['KeyUsage']
  unless params['TagFilters'].nil?
    @TagFilters = []
    params['TagFilters'].each do |i|
      tagfilter_tmp = TagFilter.new
      tagfilter_tmp.deserialize(i)
      @TagFilters << tagfilter_tmp
    end
  end
  @HsmClusterId = params['HsmClusterId']
end