1package ecs
2
3//Licensed under the Apache License, Version 2.0 (the "License");
4//you may not use this file except in compliance with the License.
5//You may obtain a copy of the License at
6//
7//http://www.apache.org/licenses/LICENSE-2.0
8//
9//Unless required by applicable law or agreed to in writing, software
10//distributed under the License is distributed on an "AS IS" BASIS,
11//WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12//See the License for the specific language governing permissions and
13//limitations under the License.
14//
15// Code generated by Alibaba Cloud SDK Code Generator.
16// Changes may cause incorrect behavior and will be lost if the code is regenerated.
17
18import (
19	"github.com/aliyun/alibaba-cloud-sdk-go/sdk/requests"
20	"github.com/aliyun/alibaba-cloud-sdk-go/sdk/responses"
21)
22
23// DescribeInstances invokes the ecs.DescribeInstances API synchronously
24// api document: https://help.aliyun.com/api/ecs/describeinstances.html
25func (client *Client) DescribeInstances(request *DescribeInstancesRequest) (response *DescribeInstancesResponse, err error) {
26	response = CreateDescribeInstancesResponse()
27	err = client.DoAction(request, response)
28	return
29}
30
31// DescribeInstancesWithChan invokes the ecs.DescribeInstances API asynchronously
32// api document: https://help.aliyun.com/api/ecs/describeinstances.html
33// asynchronous document: https://help.aliyun.com/document_detail/66220.html
34func (client *Client) DescribeInstancesWithChan(request *DescribeInstancesRequest) (<-chan *DescribeInstancesResponse, <-chan error) {
35	responseChan := make(chan *DescribeInstancesResponse, 1)
36	errChan := make(chan error, 1)
37	err := client.AddAsyncTask(func() {
38		defer close(responseChan)
39		defer close(errChan)
40		response, err := client.DescribeInstances(request)
41		if err != nil {
42			errChan <- err
43		} else {
44			responseChan <- response
45		}
46	})
47	if err != nil {
48		errChan <- err
49		close(responseChan)
50		close(errChan)
51	}
52	return responseChan, errChan
53}
54
55// DescribeInstancesWithCallback invokes the ecs.DescribeInstances API asynchronously
56// api document: https://help.aliyun.com/api/ecs/describeinstances.html
57// asynchronous document: https://help.aliyun.com/document_detail/66220.html
58func (client *Client) DescribeInstancesWithCallback(request *DescribeInstancesRequest, callback func(response *DescribeInstancesResponse, err error)) <-chan int {
59	result := make(chan int, 1)
60	err := client.AddAsyncTask(func() {
61		var response *DescribeInstancesResponse
62		var err error
63		defer close(result)
64		response, err = client.DescribeInstances(request)
65		callback(response, err)
66		result <- 1
67	})
68	if err != nil {
69		defer close(result)
70		callback(nil, err)
71		result <- 0
72	}
73	return result
74}
75
76// DescribeInstancesRequest is the request struct for api DescribeInstances
77type DescribeInstancesRequest struct {
78	*requests.RpcRequest
79	InnerIpAddresses     string                  `position:"Query" name:"InnerIpAddresses"`
80	ResourceOwnerId      requests.Integer        `position:"Query" name:"ResourceOwnerId"`
81	ImageId              string                  `position:"Query" name:"ImageId"`
82	PrivateIpAddresses   string                  `position:"Query" name:"PrivateIpAddresses"`
83	HpcClusterId         string                  `position:"Query" name:"HpcClusterId"`
84	Filter2Value         string                  `position:"Query" name:"Filter.2.Value"`
85	Filter4Value         string                  `position:"Query" name:"Filter.4.Value"`
86	IoOptimized          requests.Boolean        `position:"Query" name:"IoOptimized"`
87	SecurityGroupId      string                  `position:"Query" name:"SecurityGroupId"`
88	KeyPairName          string                  `position:"Query" name:"KeyPairName"`
89	Filter4Key           string                  `position:"Query" name:"Filter.4.Key"`
90	PageNumber           requests.Integer        `position:"Query" name:"PageNumber"`
91	ResourceGroupId      string                  `position:"Query" name:"ResourceGroupId"`
92	LockReason           string                  `position:"Query" name:"LockReason"`
93	Filter1Key           string                  `position:"Query" name:"Filter.1.Key"`
94	RdmaIpAddresses      string                  `position:"Query" name:"RdmaIpAddresses"`
95	DeviceAvailable      requests.Boolean        `position:"Query" name:"DeviceAvailable"`
96	PageSize             requests.Integer        `position:"Query" name:"PageSize"`
97	PublicIpAddresses    string                  `position:"Query" name:"PublicIpAddresses"`
98	InstanceType         string                  `position:"Query" name:"InstanceType"`
99	Tag                  *[]DescribeInstancesTag `position:"Query" name:"Tag"  type:"Repeated"`
100	InstanceChargeType   string                  `position:"Query" name:"InstanceChargeType"`
101	Filter3Value         string                  `position:"Query" name:"Filter.3.Value"`
102	DryRun               requests.Boolean        `position:"Query" name:"DryRun"`
103	ResourceOwnerAccount string                  `position:"Query" name:"ResourceOwnerAccount"`
104	OwnerAccount         string                  `position:"Query" name:"OwnerAccount"`
105	InstanceTypeFamily   string                  `position:"Query" name:"InstanceTypeFamily"`
106	Filter1Value         string                  `position:"Query" name:"Filter.1.Value"`
107	NeedSaleCycle        requests.Boolean        `position:"Query" name:"NeedSaleCycle"`
108	Filter2Key           string                  `position:"Query" name:"Filter.2.Key"`
109	OwnerId              requests.Integer        `position:"Query" name:"OwnerId"`
110	VSwitchId            string                  `position:"Query" name:"VSwitchId"`
111	EipAddresses         string                  `position:"Query" name:"EipAddresses"`
112	InstanceName         string                  `position:"Query" name:"InstanceName"`
113	InstanceIds          string                  `position:"Query" name:"InstanceIds"`
114	InternetChargeType   string                  `position:"Query" name:"InternetChargeType"`
115	VpcId                string                  `position:"Query" name:"VpcId"`
116	ZoneId               string                  `position:"Query" name:"ZoneId"`
117	Filter3Key           string                  `position:"Query" name:"Filter.3.Key"`
118	InstanceNetworkType  string                  `position:"Query" name:"InstanceNetworkType"`
119	Status               string                  `position:"Query" name:"Status"`
120}
121
122// DescribeInstancesTag is a repeated param struct in DescribeInstancesRequest
123type DescribeInstancesTag struct {
124	Value string `name:"Value"`
125	Key   string `name:"Key"`
126}
127
128// DescribeInstancesResponse is the response struct for api DescribeInstances
129type DescribeInstancesResponse struct {
130	*responses.BaseResponse
131	RequestId  string                       `json:"RequestId" xml:"RequestId"`
132	TotalCount int                          `json:"TotalCount" xml:"TotalCount"`
133	PageNumber int                          `json:"PageNumber" xml:"PageNumber"`
134	PageSize   int                          `json:"PageSize" xml:"PageSize"`
135	Instances  InstancesInDescribeInstances `json:"Instances" xml:"Instances"`
136}
137
138// CreateDescribeInstancesRequest creates a request to invoke DescribeInstances API
139func CreateDescribeInstancesRequest() (request *DescribeInstancesRequest) {
140	request = &DescribeInstancesRequest{
141		RpcRequest: &requests.RpcRequest{},
142	}
143	request.InitWithApiInfo("Ecs", "2014-05-26", "DescribeInstances", "ecs", "openAPI")
144	return
145}
146
147// CreateDescribeInstancesResponse creates a response to parse from DescribeInstances response
148func CreateDescribeInstancesResponse() (response *DescribeInstancesResponse) {
149	response = &DescribeInstancesResponse{
150		BaseResponse: &responses.BaseResponse{},
151	}
152	return
153}
154