github.com/morlay/goqcloud@v0.0.0-20181123023149-b00e0b0b9afc/clients/dcdb/describe_dcdb_instances.go (about)

     1  package dcdb
     2  
     3  import (
     4  	github_com_morlay_goqcloud "github.com/morlay/goqcloud"
     5  )
     6  
     7  // 查询实例列表
     8  // https://cloud.tencent.com/document/api/557/16140
     9  
    10  type DescribeDcdbInstancesRequest struct {
    11  	// 1非独享集群，2独享集群， 0全部
    12  	ExclusterType *int64 `name:"ExclusterType,omitempty"`
    13  	// 按照一个或者多个实例 ID 查询。实例 ID 形如：dcdbt-2t4cf98d
    14  	InstanceIds []*string `name:"InstanceIds,omitempty"`
    15  	// 标识是否使用ExclusterType字段, false不使用，true使用
    16  	IsFilterExcluster *bool `name:"IsFilterExcluster,omitempty"`
    17  	// 是否根据 VPC 网络来搜索
    18  	IsFilterVpc *bool `name:"IsFilterVpc,omitempty"`
    19  	// 返回数量，默认为 10，最大值为 100。
    20  	Limit *int64 `name:"Limit,omitempty"`
    21  	// 偏移量，默认为 0
    22  	Offset *int64 `name:"Offset,omitempty"`
    23  	// 排序字段， projectId， createtime， instancename 三者之一
    24  	OrderBy *string `name:"OrderBy,omitempty"`
    25  	// 排序类型， desc 或者 asc
    26  	OrderByType *string `name:"OrderByType,omitempty"`
    27  	// 按项目 ID 查询
    28  	ProjectIds []*int64 `name:"ProjectIds,omitempty"`
    29  	// 区域
    30  	Region string `name:"Region"`
    31  	// 搜索的关键字，支持模糊搜索。多个关键字使用换行符（'\n'）分割。
    32  	SearchKey *string `name:"SearchKey,omitempty"`
    33  	// 搜索的字段名，当前支持的值有：instancename、vip、all。传 instancename 表示按实例名进行搜索；传 vip 表示按内网IP进行搜索；传 all 将会按实例ID、实例名和内网IP进行搜索。
    34  	SearchName *string `name:"SearchName,omitempty"`
    35  	// 私有网络的子网 ID， IsFilterVpc 为 1 时有效
    36  	SubnetId *string `name:"SubnetId,omitempty"`
    37  	// 私有网络 ID， IsFilterVpc 为 1 时有效
    38  	VpcId *string `name:"VpcId,omitempty"`
    39  }
    40  
    41  func (req *DescribeDcdbInstancesRequest) Invoke(client github_com_morlay_goqcloud.Client) (*DescribeDcdbInstancesResponse, error) {
    42  	resp := &DescribeDcdbInstancesResponse{}
    43  	err := client.Request("dcdb", "DescribeDCDBInstances", "2018-04-11").Do(req, resp)
    44  	return resp, err
    45  }
    46  
    47  type DescribeDcdbInstancesResponse struct {
    48  	github_com_morlay_goqcloud.TencentCloudBaseResponse
    49  	// 实例详细信息列表
    50  	Instances []*DCDBInstanceInfo `json:"Instances"`
    51  	// 符合条件的实例数量
    52  	TotalCount int64 `json:"TotalCount"`
    53  }