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

     1  package cdb
     2  
     3  import (
     4  	github_com_morlay_goqcloud "github.com/morlay/goqcloud"
     5  )
     6  
     7  // 查询实例列表
     8  // https://cloud.tencent.com/document/api/236/15872
     9  
    10  type DescribeDbInstancesRequest struct {
    11  	// 是否锁定标记
    12  	CdbErrors []*int64 `name:"CdbErrors,omitempty"`
    13  	// 实例数据库引擎版本，可能取值：5.1、5.5、5.6和5.7
    14  	EngineVersions []*string `name:"EngineVersions,omitempty"`
    15  	// 独享集群ID
    16  	ExClusterId *string `name:"ExClusterId,omitempty"`
    17  	// 初始化标记，可取值：0-未初始化，1-初始化
    18  	InitFlag *int64 `name:"InitFlag,omitempty"`
    19  	// 实例ID
    20  	InstanceIds []*string `name:"InstanceIds,omitempty"`
    21  	// 实例名称
    22  	InstanceNames []*string `name:"InstanceNames,omitempty"`
    23  	// 实例类型，可取值：1-主实例，2-灾备实例，3-只读实例
    24  	InstanceTypes []*int64 `name:"InstanceTypes,omitempty"`
    25  	// 单次请求返回的数量，默认值为20，最大值为2000
    26  	Limit *int64 `name:"Limit,omitempty"`
    27  	// 偏移量，默认值为0
    28  	Offset *int64 `name:"Offset,omitempty"`
    29  	// 返回结果集排序的字段，目前支持："InstanceId", "InstanceName", "CreateTime", "DeadlineTime"
    30  	OrderBy *string `name:"OrderBy,omitempty"`
    31  	// 返回结果集排序方式，目前支持："ASC"或者"DESC"
    32  	OrderDirection *string `name:"OrderDirection,omitempty"`
    33  	// 付费类型，可取值：0-包年包月，1-小时计费
    34  	PayTypes []*int64 `name:"PayTypes,omitempty"`
    35  	// 项目ID，可使用查询项目列表接口查询项目ID
    36  	ProjectId *int64 `name:"ProjectId,omitempty"`
    37  	// 区域
    38  	Region string `name:"Region"`
    39  	// 安全组ID
    40  	SecurityGroupId *string `name:"SecurityGroupId,omitempty"`
    41  	// 实例状态，可取值：0-创建中，1-运行中，4-隔离中，5-已隔离
    42  	Status []*int64 `name:"Status,omitempty"`
    43  	// 子网ID
    44  	SubnetIds []*int64 `name:"SubnetIds,omitempty"`
    45  	// 实例任务状态，可能取值：0-没有任务1-升级中2-数据导入中3-开放Slave中4-外网访问开通中5-批量操作执行中6-回档中7-外网访问关闭中8-密码修改中9-实例名修改中10-重启中12-自建迁移中13-删除库表中14-灾备实例创建同步中
    46  	TaskStatus []*int64 `name:"TaskStatus,omitempty"`
    47  	// 实例的内网IP地址
    48  	Vips []*string `name:"Vips,omitempty"`
    49  	// 私有网络的ID
    50  	VpcIds []*int64 `name:"VpcIds,omitempty"`
    51  	// 是否包含灾备实例，可取值：0-不包含，1-包含
    52  	WithDr *int64 `name:"WithDr,omitempty"`
    53  	// 是否包含独享集群详细信息，可取值：0-不包含，1-包含
    54  	WithExCluster *int64 `name:"WithExCluster,omitempty"`
    55  	// 是否包含主实例，可取值：0-不包含，1-包含
    56  	WithMaster *int64 `name:"WithMaster,omitempty"`
    57  	// 是否包含只读实例，可取值：0-不包含，1-包含
    58  	WithRo *int64 `name:"WithRo,omitempty"`
    59  	// 是否包含安全组详细信息，可取值：0-不包含，1-包含
    60  	WithSecurityGroup *int64 `name:"WithSecurityGroup,omitempty"`
    61  	// 可用区的ID
    62  	ZoneIds []*int64 `name:"ZoneIds,omitempty"`
    63  }
    64  
    65  func (req *DescribeDbInstancesRequest) Invoke(client github_com_morlay_goqcloud.Client) (*DescribeDbInstancesResponse, error) {
    66  	resp := &DescribeDbInstancesResponse{}
    67  	err := client.Request("cdb", "DescribeDBInstances", "2017-03-20").Do(req, resp)
    68  	return resp, err
    69  }
    70  
    71  type DescribeDbInstancesResponse struct {
    72  	github_com_morlay_goqcloud.TencentCloudBaseResponse
    73  	// 实例详细信息
    74  	Items []*InstanceInfo `json:"Items"`
    75  	// 符合查询条件的实例总数
    76  	TotalCount int64 `json:"TotalCount"`
    77  }