Class: TencentCloud::Cvm::V20170312::DescribeImagesRequest

Inherits:

TencentCloud::Common::AbstractModel

• Object
• TencentCloud::Common::AbstractModel
• TencentCloud::Cvm::V20170312::DescribeImagesRequest

Defined in:

lib/v20170312/models.rb

Overview

DescribeImages请求参数结构体

Instance Attribute Summary

• #Filters ⇒ Object
• #ImageIds ⇒ Object
• #InstanceType ⇒ Object
• #Limit ⇒ Object
• #Offset ⇒ Object

Instance Method Summary

• #deserialize(params) ⇒ Object
• #initialize(imageids = nil, filters = nil, offset = nil, limit = nil, instancetype = nil) ⇒ DescribeImagesRequest constructor

  A new instance of DescribeImagesRequest.

Constructor Details

#initialize(imageids = nil, filters = nil, offset = nil, limit = nil, instancetype = nil) ⇒ DescribeImagesRequest

Returns a new instance of DescribeImagesRequest.

# File 'lib/v20170312/models.rb', line 2390

def initialize(imageids=nil, filters=nil, offset=nil, limit=nil, instancetype=nil)
  @ImageIds = imageids
  @Filters = filters
  @Offset = offset
  @Limit = limit
  @InstanceType = instancetype
end

Instance Attribute Details

#Filters ⇒ Object

Parameters:

• ImageIds: —

  镜像ID列表 。镜像ID如：img-gvbnzy6f。array型参数的格式可以参考API简介。镜像ID可以通过如下方式获取：
  

• 通过DescribeImages接口返回的ImageId获取。
• 通过镜像控制台获取。

Filters: —

过滤条件，每次请求的Filters的上限为10，Filters.Values的上限为5。参数不可以同时指定ImageIds和Filters。详细的过滤条件如下：

image-id

按照【镜像ID】进行过滤。

类型：String

必选：否

image-type

按照【镜像类型】进行过滤。

类型：String

必选：否

可选项：

PRIVATE_IMAGE: 自定义镜像 (本账户创建的镜像)

PUBLIC_IMAGE: 公共镜像 (腾讯云官方镜像)

SHARED_IMAGE: 共享镜像(其他账户共享给本账户的镜像)

image-name

按照【镜像名称】进行过滤。支持模糊查询。

类型：String

必选：否

platform

按照【镜像平台】进行过滤，如 CentOS，支持模糊匹配。可通过 DescribeImages 接口返回的 Platform 获取。

类型：String

必选：否

tag-key

按照【标签键】进行过滤。可通过 GetTags 接口返回的 TagKey 获取。

类型：String

必选：否

tag-value

按照【标签值】进行过滤。可通过 GetTags 接口返回的 TagValue 获取。

类型：String

必选：否

tag:tag-key

按照【标签键值对】进行过滤。tag-key使用具体的标签键进行替换。可通过 GetTags 接口返回的 TagKey 和 TagValue 获取。

类型：String

必选：否

dedicated-cluster-id

按照【本地专用集群CDC ID】进行过滤。可通过 DescribeDedicatedClusters 接口返回的 DedicatedClusterSet 获取。

类型：String

必选：否

cdc-cache-status

按照【CDC镜像缓存状态】进行过滤。

类型：String

必选：否

可选项：

CACHED_ALL: 全部缓存状态

CACHING: 缓存中

CACHED: 已缓存

CACHE_INVALID: 缓存失效

CACHE_FAILED: 缓存失败

Offset: —

偏移量，默认为0。关于Offset详见API简介。

Limit: —

数量限制，默认为20，最大值为100。关于Limit详见API简介。

InstanceType: —

实例类型，如 SA5.MEDIUM2。可通过 DescribeInstanceTypeConfigs 接口返回的 InstanceType 获取。

# File 'lib/v20170312/models.rb', line 2388

def Filters
  @Filters
end