summaryrefslogtreecommitdiff
path: root/data/en_us/domain/2018-02-08/api-docs.php
blob: 356ee9d50b272b9b43fda79e4573876400daad1e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
<?php return [
    'version' => '1.0',
    'info' => ['style' => 'RPC', 'product' => 'Domain', 'version' => '2018-02-08'],
    'directories' => ['QueryBrokerDemand', 'CreateFixedPriceSelectedOrder', 'CheckSelectedDomainStatus', 'SelectedDomainList', 'QueryExchangeRate'],
    'components' => [
        'schemas' => [],
    ],
    'apis' => [
        'QueryBrokerDemand' => [
            'summary' => 'Queries the details of requests.',
            'methods' => ['post', 'get'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'APP' => [],
                ],
                [
                    'AK' => [],
                ],
                [
                    'PrivateKey' => [],
                ],
            ],
            'operationType' => 'read',
            'deprecated' => false,
            'systemTags' => ['operationType' => 'list'],
            'parameters' => [
                [
                    'name' => 'Status',
                    'in' => 'query',
                    'schema' => [
                        'description' => '',
                        'type' => 'string',
                        'required' => false,
                        'example' => '1',
                        'enum' => ['1', '2', '3', '4', '5', '6', '7', '8', '9'],
                    ],
                ],
                [
                    'name' => 'CurrentPage',
                    'in' => 'query',
                    'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'],
                ],
                [
                    'name' => 'PageSize',
                    'in' => 'query',
                    'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '10', 'example' => '20', 'default' => '10'],
                ],
                [
                    'name' => 'BizId',
                    'in' => 'query',
                    'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'SE20183915FI0178'],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'type' => 'object',
                        'properties' => [
                            'CurrentPageNum' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
                            'TotalPageNum' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
                            'PageSize' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
                            'RequestId' => ['description' => '', 'type' => 'string', 'example' => '497F7522-82B0-4BD4-84FE-AE8749E4C2F9'],
                            'TotalItemNum' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
                            'Data' => [
                                'description' => '',
                                'type' => 'array',
                                'items' => [
                                    'type' => 'object',
                                    'properties' => [
                                        'Status' => ['description' => '', 'type' => 'string', 'example' => '1'],
                                        'DemandPrice' => ['description' => '', 'type' => 'number', 'format' => 'float', 'example' => '1'],
                                        'BizId' => ['description' => '', 'type' => 'string', 'example' => 'SE20183915FI0178'],
                                        'BargainSellerMobile' => ['description' => '', 'type' => 'string', 'example' => '13300000001'],
                                        'PublishTime' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1524800053000'],
                                        'ProduceType' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
                                        'DemandDomain' => ['description' => '', 'type' => 'string', 'example' => 'taobao.com'],
                                        'Description' => ['description' => '', 'type' => 'string', 'example' => ''],
                                        'Mobile' => ['description' => '', 'type' => 'string', 'example' => '13300000000'],
                                        'ServicePayPrice' => ['description' => '', 'type' => 'number', 'format' => 'float', 'example' => '18800'],
                                        'PayPrice' => ['description' => '', 'type' => 'number', 'format' => 'float', 'example' => '100'],
                                        'PayTime' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1524800053000'],
                                        'BargainSellerPrice' => ['description' => '', 'type' => 'number', 'format' => 'float', 'example' => '100'],
                                        'OrderType' => ['type' => 'integer', 'format' => 'int32'],
                                        'PayDomain' => ['description' => '', 'type' => 'string', 'example' => 'test.com'],
                                        'AuditStatus' => ['type' => 'integer', 'format' => 'int32'],
                                        'PartnerDomain' => ['type' => 'string'],
                                        'PurchaseStatus' => ['type' => 'integer', 'format' => 'int32'],
                                        'Email' => ['type' => 'string'],
                                        'SettleBasePrice' => ['type' => 'number', 'format' => 'float'],
                                    ],
                                ],
                            ],
                        ],
                    ],
                ],
            ],
            'errorCodes' => [
                400 => [
                    ['errorCode' => 'ParameterIllegall', 'errorMessage' => 'The specified parameter is not valid.'],
                    ['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'The user has no resource authorization, or the API does not support ram.'],
                ],
                500 => [
                    ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
                ],
            ],
            'responseDemo' => '[{"errorExample":"","example":"{\\n  \\"CurrentPageNum\\": 1,\\n  \\"TotalPageNum\\": 15,\\n  \\"PageSize\\": 20,\\n  \\"RequestId\\": \\"497F7522-82B0-4BD4-84FE-AE8749E4C2F9\\",\\n  \\"TotalItemNum\\": 333,\\n  \\"Data\\": [\\n    {\\n      \\"Status\\": \\"1\\",\\n      \\"DemandPrice\\": 1,\\n      \\"BizId\\": \\"T20230428100121000101\\",\\n      \\"BargainSellerMobile\\": \\"13300000001\\",\\n      \\"PublishTime\\": 1524800053000,\\n      \\"ProduceType\\": 1,\\n      \\"DemandDomain\\": \\"taobao.com\\",\\n      \\"Description\\": \\"我要淘宝\\",\\n      \\"Mobile\\": \\"13300000000\\",\\n      \\"ServicePayPrice\\": 18800,\\n      \\"PayPrice\\": 100,\\n      \\"PayTime\\": 1524800053000,\\n      \\"BargainSellerPrice\\": 100,\\n      \\"OrderType\\": 1,\\n      \\"PayDomain\\": \\"test.com\\",\\n      \\"AuditStatus\\": 1,\\n      \\"PartnerDomain\\": \\"test.com\\\\n\\",\\n      \\"PurchaseStatus\\": 1,\\n      \\"Email\\": \\"test@126.com\\",\\n      \\"SettleBasePrice\\": 0\\n    }\\n  ]\\n}","type":"json"}]',
            'title' => 'QueryBrokerDemand',
        ],
        'CreateFixedPriceSelectedOrder' => [
            'summary' => '一口价严选下单购买接口,阿里云账户余额直接扣费',
            'methods' => ['post'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'read',
            'deprecated' => false,
            'systemTags' => [
                'operationType' => 'create',
                'riskType' => 'high',
                'chargeType' => 'paid',
                'abilityTreeNodes' => ['FEATUREdomain3EBBI7'],
            ],
            'parameters' => [
                [
                    'name' => 'DomainName',
                    'in' => 'query',
                    'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'example' => 'example.com', 'docRequired' => true],
                ],
                [
                    'name' => 'Code',
                    'in' => 'query',
                    'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'DX123456'],
                ],
                [
                    'name' => 'Source',
                    'in' => 'query',
                    'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'partnername'],
                ],
                [
                    'name' => 'ContactId',
                    'in' => 'query',
                    'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'example' => '11935401', 'docRequired' => true],
                ],
                [
                    'name' => 'ExpectedPrice',
                    'in' => 'query',
                    'schema' => ['description' => '', 'type' => 'number', 'format' => 'double', 'required' => true, 'example' => '20.00', 'docRequired' => true],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'title' => 'PopResultDTO<PayUrlResult>',
                        'description' => 'PopResultDTO<PayUrlResult>',
                        'type' => 'object',
                        'properties' => [
                            'RequestId' => ['description' => '', 'type' => 'string', 'example' => 'C50E41A0-09F1-4491-8DB8-AF55BD2D0CC8'],
                            'Module' => [
                                'description' => '',
                                'type' => 'object',
                                'properties' => [
                                    'OrderNo' => ['description' => '', 'type' => 'string', 'example' => '31199295f2074ce895645d386cb22c36'],
                                    'Domain' => ['title' => '域名', 'description' => '', 'type' => 'string', 'example' => 'example.com'],
                                    'Price' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '20.00'],
                                    'DomainBlockTrade' => [
                                        'type' => 'array',
                                        'items' => ['type' => 'string'],
                                    ],
                                    'BizIds' => [
                                        'title' => '业务ID映射',
                                        'type' => 'object',
                                        'additionalProperties' => ['title' => '业务ID映射', 'type' => 'string', 'example' => '{"test.com":"T2023122019031400****"}'],
                                    ],
                                ],
                            ],
                            'HttpStatusCode' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
                            'ErrorCode' => ['description' => '', 'type' => 'string', 'example' => 'DomainNotOnSale'],
                            'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'True'],
                        ],
                    ],
                ],
            ],
            'errorCodes' => [
                400 => [
                    ['errorCode' => 'InsufficientAccountBalance', 'errorMessage' => 'Aliyun account balance is insufficient, unable to submit strictly selected domain name purchase.'],
                    ['errorCode' => 'UnexpectedRealPrice', 'errorMessage' => 'When placing an order, the selling price of the domain name does not match the expectation.'],
                    ['errorCode' => 'DomainNotOnSale', 'errorMessage' => 'The domain name is not currently for sale.'],
                    ['errorCode' => 'NotSelectedDomain', 'errorMessage' => 'The domain name is not strictly selected goods.'],
                    ['errorCode' => 'ParameterError', 'errorMessage' => 'Parameter error.'],
                ],
            ],
            'responseDemo' => '[{"errorExample":"","example":"{\\n  \\"RequestId\\": \\"C50E41A0-09F1-4491-8DB8-AF55BD2D0CC8\\",\\n  \\"Module\\": {\\n    \\"OrderNo\\": \\"31199295f2074ce895645d386cb22c36\\",\\n    \\"Domain\\": \\"example.com\\",\\n    \\"Price\\": 20,\\n    \\"DomainBlockTrade\\": [\\n      \\"test.com\\"\\n    ],\\n    \\"BizIds\\": {\\n      \\"key\\": \\"T2023122019031400****\\"\\n    }\\n  },\\n  \\"HttpStatusCode\\": 200,\\n  \\"ErrorCode\\": \\"DomainNotOnSale\\",\\n  \\"Success\\": true\\n}","type":"json"}]',
        ],
        'CheckSelectedDomainStatus' => [
            'summary' => '一口价严选询价接口',
            'methods' => ['get', 'post'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'read',
            'deprecated' => false,
            'systemTags' => ['operationType' => 'get'],
            'parameters' => [
                [
                    'name' => 'Domain',
                    'in' => 'query',
                    'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'example' => 'example.com', 'docRequired' => true],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'title' => 'PopResultDTO<FixedPriceDomainVo>',
                        'description' => 'PopResultDTO<FixedPriceDomainVo>',
                        'type' => 'object',
                        'properties' => [
                            'RequestId' => ['description' => '', 'type' => 'string', 'example' => 'E2598CAF-DBFE-494E-95EF-B42A33C178AA'],
                            'ErrorCode' => ['description' => '', 'type' => 'string', 'example' => 'OssFileNotFound'],
                            'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'True'],
                            'Module' => [
                                'description' => '',
                                'type' => 'object',
                                'properties' => [
                                    'Domain' => ['description' => '', 'type' => 'string', 'example' => 'example.com'],
                                    'Price' => ['description' => '', 'type' => 'number', 'format' => 'double', 'example' => '20.00'],
                                    'RegDate' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1566353497'],
                                    'DeadDate' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1567353497'],
                                    'EndTime' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1567353497'],
                                    'Premium' => ['title' => '是否为溢价词域名,true是false否', 'type' => 'boolean'],
                                ],
                            ],
                            'HttpStatusCode' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
                        ],
                    ],
                ],
            ],
            'errorCodes' => [
                400 => [
                    ['errorCode' => 'NotSelectedDomain', 'errorMessage' => 'The domain name is not strictly selected goods.'],
                    ['errorCode' => 'DomainNotOnSale', 'errorMessage' => 'The domain name is not currently for sale.'],
                    ['errorCode' => 'ParameterError', 'errorMessage' => 'Parameter error.'],
                ],
            ],
            'responseDemo' => '[{"errorExample":"","example":"{\\n  \\"RequestId\\": \\"E2598CAF-DBFE-494E-95EF-B42A33C178AA\\",\\n  \\"ErrorCode\\": \\"OssFileNotFound\\",\\n  \\"Success\\": true,\\n  \\"Module\\": {\\n    \\"Domain\\": \\"example.com\\",\\n    \\"Price\\": 20,\\n    \\"RegDate\\": 1566353497,\\n    \\"DeadDate\\": 1567353497,\\n    \\"EndTime\\": 1567353497,\\n    \\"Premium\\": true\\n  },\\n  \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
        ],
        'SelectedDomainList' => [
            'summary' => '严选列表导出,明日凌晨2点前生成文件,导出凌晨1点前所有在售严选域名',
            'methods' => ['get', 'post'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'read',
            'deprecated' => false,
            'systemTags' => ['operationType' => 'none'],
            'parameters' => [
                [
                    'name' => 'ListDate',
                    'in' => 'query',
                    'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'example' => '20231109', 'docRequired' => true],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'title' => 'Schema of Response',
                        'description' => 'Schema of Response',
                        'type' => 'object',
                        'properties' => [
                            'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '80011ABC-F573-4795-B0E8-377BFBBA3422'],
                            'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'True'],
                            'ErrorCode' => ['description' => '', 'type' => 'string', 'example' => 'OssFileNotFound'],
                            'Module' => [
                                'description' => '',
                                'type' => 'object',
                                'properties' => [
                                    'DownloadUrl' => ['description' => '', 'type' => 'string', 'example' => 'http://selected-domain.oss-cn-zhangjiakou.aliyuncs.com/aliyun_selected_domain_20231109.gz?Expires=1699524493&OSSAccessKeyId=LTAI5tPMAybR4gfSEjdfAk1F&Signature=2Tpo7Eaf%2BqIop8SuMtI91m%2FAFpY%3D'],
                                ],
                            ],
                        ],
                    ],
                ],
            ],
            'errorCodes' => [
                400 => [
                    ['errorCode' => 'SelectedListFileNotFound', 'errorMessage' => 'Selected domain list file not found, possibly because the list has not been generated yet. It is usually completed before 2 am.'],
                    ['errorCode' => 'InputIllegal', 'errorMessage' => 'The input date is not the current day or the input format is not as expected (the example input is "20231109", which must be the current day of the call date).'],
                ],
            ],
            'staticInfo' => ['returnType' => 'synchronous'],
            'responseDemo' => '[{"errorExample":"","example":"{\\n  \\"RequestId\\": \\"80011ABC-F573-4795-B0E8-377BFBBA3422\\",\\n  \\"Success\\": true,\\n  \\"ErrorCode\\": \\"OssFileNotFound\\",\\n  \\"Module\\": {\\n    \\"DownloadUrl\\": \\"http://selected-domain.oss-cn-zhangjiakou.aliyuncs.com/aliyun_selected_domain_20231109.gz?Expires=1699524493&OSSAccessKeyId=LTAI5tPMAybR4gfSEjdfAk1F&Signature=2Tpo7Eaf%2BqIop8SuMtI91m%2FAFpY%3D\\"\\n  }\\n}","type":"json"}]',
        ],
        'QueryExchangeRate' => [
            'summary' => '查询汇率',
            'path' => '',
            'methods' => ['get', 'post'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'read',
            'deprecated' => false,
            'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
            'parameters' => [
                [
                    'name' => 'FromCurrency',
                    'in' => 'query',
                    'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'example' => 'USD'],
                ],
                [
                    'name' => 'ToCurrency',
                    'in' => 'query',
                    'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'example' => 'CNY'],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'title' => 'Schema of Response',
                        'description' => 'Schema of Response',
                        'type' => 'object',
                        'properties' => [
                            'ExchangeRate' => ['description' => '', 'type' => 'number', 'format' => 'double', 'example' => '7.12'],
                            'RequestId' => ['description' => '', 'type' => 'string', 'example' => 'D200000-C0B9-4CD3-B92A-9B44A000000'],
                        ],
                    ],
                ],
            ],
            'staticInfo' => ['returnType' => 'synchronous'],
            'responseDemo' => '[{"errorExample":"","example":"{\\n  \\"ExchangeRate\\": 7.12,\\n  \\"RequestId\\": \\"D200000-C0B9-4CD3-B92A-9B44A000000\\"\\n}","type":"json"}]',
        ],
    ],
    'endpoints' => [
        ['regionId' => 'cn-hangzhou', 'endpoint' => 'domain.aliyuncs.com'],
        ['regionId' => 'ap-southeast-1', 'endpoint' => 'domain-intl.aliyuncs.com'],
    ],
];