DescribeUserViewIP.go raw
1 // Copyright 2018 JDCLOUD.COM
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 // NOTE: This class is auto generated by the jdcloud code generator program.
16
17 package apis
18
19 import (
20 "github.com/go-acme/jdcloud-sdk-go/core"
21 )
22
23 type DescribeUserViewIPRequest struct {
24 core.JDCloudRequest
25
26 /* 地域ID */
27 RegionId string `json:"regionId"`
28
29 /* 域名ID，请使用describeDomains接口获取。 */
30 DomainId string `json:"domainId"`
31
32 /* 自定义线路ID */
33 ViewId int `json:"viewId"`
34
35 /* 自定义线路名称, 最多64个字节，允许：数字、字母、下划线，-，中文 (Optional) */
36 ViewName *string `json:"viewName"`
37
38 /* 分页参数，页的序号, 默认为1 */
39 PageNumber int `json:"pageNumber"`
40
41 /* 分页参数，每页含有的结果的数目，默认为10 */
42 PageSize int `json:"pageSize"`
43 }
44
45 /*
46 * param regionId: 地域ID (Required)
47 * param domainId: 域名ID，请使用describeDomains接口获取。 (Required)
48 * param viewId: 自定义线路ID (Required)
49 * param pageNumber: 分页参数，页的序号, 默认为1 (Required)
50 * param pageSize: 分页参数，每页含有的结果的数目，默认为10 (Required)
51 *
52 * @Deprecated, not compatible when mandatory parameters changed
53 */
54 func NewDescribeUserViewIPRequest(
55 regionId string,
56 domainId string,
57 viewId int,
58 pageNumber int,
59 pageSize int,
60 ) *DescribeUserViewIPRequest {
61
62 return &DescribeUserViewIPRequest{
63 JDCloudRequest: core.JDCloudRequest{
64 URL: "/regions/{regionId}/domain/{domainId}/UserViewIP",
65 Method: "GET",
66 Header: nil,
67 Version: "v2",
68 },
69 RegionId: regionId,
70 DomainId: domainId,
71 ViewId: viewId,
72 PageNumber: pageNumber,
73 PageSize: pageSize,
74 }
75 }
76
77 /*
78 * param regionId: 地域ID (Required)
79 * param domainId: 域名ID，请使用describeDomains接口获取。 (Required)
80 * param viewId: 自定义线路ID (Required)
81 * param viewName: 自定义线路名称, 最多64个字节，允许：数字、字母、下划线，-，中文 (Optional)
82 * param pageNumber: 分页参数，页的序号, 默认为1 (Required)
83 * param pageSize: 分页参数，每页含有的结果的数目，默认为10 (Required)
84 */
85 func NewDescribeUserViewIPRequestWithAllParams(
86 regionId string,
87 domainId string,
88 viewId int,
89 viewName *string,
90 pageNumber int,
91 pageSize int,
92 ) *DescribeUserViewIPRequest {
93
94 return &DescribeUserViewIPRequest{
95 JDCloudRequest: core.JDCloudRequest{
96 URL: "/regions/{regionId}/domain/{domainId}/UserViewIP",
97 Method: "GET",
98 Header: nil,
99 Version: "v2",
100 },
101 RegionId: regionId,
102 DomainId: domainId,
103 ViewId: viewId,
104 ViewName: viewName,
105 PageNumber: pageNumber,
106 PageSize: pageSize,
107 }
108 }
109
110 /* This constructor has better compatible ability when API parameters changed */
111 func NewDescribeUserViewIPRequestWithoutParam() *DescribeUserViewIPRequest {
112
113 return &DescribeUserViewIPRequest{
114 JDCloudRequest: core.JDCloudRequest{
115 URL: "/regions/{regionId}/domain/{domainId}/UserViewIP",
116 Method: "GET",
117 Header: nil,
118 Version: "v2",
119 },
120 }
121 }
122
123 /* param regionId: 地域ID(Required) */
124 func (r *DescribeUserViewIPRequest) SetRegionId(regionId string) {
125 r.RegionId = regionId
126 }
127
128 /* param domainId: 域名ID，请使用describeDomains接口获取。(Required) */
129 func (r *DescribeUserViewIPRequest) SetDomainId(domainId string) {
130 r.DomainId = domainId
131 }
132
133 /* param viewId: 自定义线路ID(Required) */
134 func (r *DescribeUserViewIPRequest) SetViewId(viewId int) {
135 r.ViewId = viewId
136 }
137
138 /* param viewName: 自定义线路名称, 最多64个字节，允许：数字、字母、下划线，-，中文(Optional) */
139 func (r *DescribeUserViewIPRequest) SetViewName(viewName string) {
140 r.ViewName = &viewName
141 }
142
143 /* param pageNumber: 分页参数，页的序号, 默认为1(Required) */
144 func (r *DescribeUserViewIPRequest) SetPageNumber(pageNumber int) {
145 r.PageNumber = pageNumber
146 }
147
148 /* param pageSize: 分页参数，每页含有的结果的数目，默认为10(Required) */
149 func (r *DescribeUserViewIPRequest) SetPageSize(pageSize int) {
150 r.PageSize = pageSize
151 }
152
153 // GetRegionId returns path parameter 'regionId' if exist,
154 // otherwise return empty string
155 func (r DescribeUserViewIPRequest) GetRegionId() string {
156 return r.RegionId
157 }
158
159 type DescribeUserViewIPResponse struct {
160 RequestID string `json:"requestId"`
161 Error core.ErrorResponse `json:"error"`
162 Result DescribeUserViewIPResult `json:"result"`
163 }
164
165 type DescribeUserViewIPResult struct {
166 DataList []string `json:"dataList"`
167 CurrentCount int `json:"currentCount"`
168 TotalCount int `json:"totalCount"`
169 TotalPage int `json:"totalPage"`
170 }
171