summaryrefslogtreecommitdiff
path: root/data/zh_cn/domain/2018-02-08/api-docs.php
blob: 68433afebacfaf5651e2328ebcab27bcd72e736b (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
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
<?php return [
    'version' => '1.0',
    'info' => [
        'style' => 'RPC',
        'product' => 'Domain',
        'version' => '2018-02-08',
    ],
    'directories' => [
        [
            'id' => 0,
            'title' => '其它',
            'type' => 'directory',
            'children' => [
                'QueryBrokerDemand',
                'CreateFixedPriceSelectedOrder',
                'CheckSelectedDomainStatus',
                'SelectedDomainList',
                'QueryExchangeRate',
            ],
        ],
    ],
    'components' => [
        'schemas' => [],
    ],
    'apis' => [
        'QueryBrokerDemand' => [
            'summary' => '查询需求详情列表。',
            'methods' => [
                'post',
                'get',
            ],
            'schemes' => [
                'http',
                'https',
            ],
            'security' => [
                [
                    'APP' => [],
                ],
                [
                    'AK' => [],
                ],
                [
                    'PrivateKey' => [],
                ],
            ],
            'operationType' => 'read',
            'deprecated' => false,
            'systemTags' => [
                'operationType' => 'list',
            ],
            'parameters' => [
                [
                    'name' => 'Status',
                    'in' => 'query',
                    'schema' => [
                        'description' => '需要查询的需求状态'."\n"
                            .'* 1:待接单'."\n"
                            .'* 2:处理中'."\n"
                            .'* 3:已拒绝'."\n"
                            .'* 4:待支付'."\n"
                            .'* 5:已关闭'."\n"
                            .'* 6:已支付'."\n"
                            .'* 7:待生产'."\n"
                            .'* 8:待确认'."\n"
                            .'* 9:已完成',
                        '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' => '业务ID',
                        'type' => 'string',
                        'required' => false,
                        'example' => 'T20230603150853000101',
                    ],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'type' => 'object',
                        'properties' => [
                            'CurrentPageNum' => [
                                'description' => '当前页码',
                                'type' => 'integer',
                                'format' => 'int32',
                                'example' => '1',
                            ],
                            'TotalPageNum' => [
                                'description' => '总页数',
                                'type' => 'integer',
                                'format' => 'int32',
                                'example' => '15',
                            ],
                            'PageSize' => [
                                'description' => '分页大小',
                                'type' => 'integer',
                                'format' => 'int32',
                                'example' => '20',
                            ],
                            'RequestId' => [
                                'description' => '请求ID。',
                                'type' => 'string',
                                'example' => '497F7522-82B0-4BD4-84FE-AE8749E4C2F9',
                            ],
                            'TotalItemNum' => [
                                'description' => '总条数',
                                'type' => 'integer',
                                'format' => 'int32',
                                'example' => '333',
                            ],
                            'Data' => [
                                'description' => '需求列表',
                                'type' => 'array',
                                'items' => [
                                    'type' => 'object',
                                    'properties' => [
                                        'Status' => [
                                            'description' => '需求状态'."\n"
                                                .'* 1:待接单'."\n"
                                                .'* 2:处理中'."\n"
                                                .'* 3:已拒绝'."\n"
                                                .'* 4:待支付'."\n"
                                                .'* 5:已关闭'."\n"
                                                .'* 6:已支付'."\n"
                                                .'* 7:待生产'."\n"
                                                .'* 8:待确认'."\n"
                                                .'* 9:已完成',
                                            'type' => 'string',
                                            'example' => '1',
                                        ],
                                        'DemandPrice' => [
                                            'description' => '期望价格(元)',
                                            'type' => 'number',
                                            'format' => 'float',
                                            'example' => '1',
                                        ],
                                        'BizId' => [
                                            'description' => '业务id',
                                            'type' => 'string',
                                            'example' => 'T20230428100121000101',
                                        ],
                                        'BargainSellerMobile' => [
                                            'description' => '议价卖家联系方式(结束状态下的订单,不显示)',
                                            'type' => 'string',
                                            'example' => '13300000001',
                                        ],
                                        'PublishTime' => [
                                            'description' => '发布时间。',
                                            'type' => 'integer',
                                            'format' => 'int64',
                                            'example' => '1524800053000',
                                        ],
                                        'ProduceType' => [
                                            'description' => '生产类型:'."\n"
                                                .'* 1:自动生产'."\n"
                                                .'* 2:合作方触发生产',
                                            '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' => [
                                            'description' => '订单类型,取值范围'."\n"
                                                .'- 1:订单指派'."\n"
                                                .'- 2:定向商机'."\n"
                                                .'- 3:被动商机'."\n"
                                                .'- 4:一口价转回购'."\n"
                                                .'- 5:一口价输出'."\n"
                                                .'- 6:一口价严选'."\n"
                                                .'- 7:国际站订单指派'."\n"
                                                .'- 8:国际站定向商机'."\n"
                                                .'- 9:国际站被动商机',
                                            'type' => 'integer',
                                            'format' => 'int32',
                                            'example' => '1',
                                        ],
                                        'PayDomain' => [
                                            'description' => '合作方提交的域名',
                                            'type' => 'string',
                                            'example' => 'test.com',
                                        ],
                                        'AuditStatus' => [
                                            'description' => '回购需求审核状态。取值:'."\n"
                                                ."\n"
                                                .'- **1**:审核中'."\n"
                                                .'- **2**、审核通过'."\n"
                                                .'- **3**:审核不通过',
                                            'type' => 'integer',
                                            'format' => 'int32',
                                            'example' => '1',
                                        ],
                                        'PartnerDomain' => [
                                            'description' => '合作方提交的域名',
                                            'type' => 'string',
                                            'example' => 'test.com'."\n",
                                        ],
                                        'PurchaseStatus' => [
                                            'description' => '(严选)采购状态,取值范围'."\n"
                                                .'- 1:是'."\n"
                                                .'- 2:否',
                                            'type' => 'integer',
                                            'format' => 'int32',
                                            'example' => '1',
                                        ],
                                        'Email' => [
                                            'description' => '邮箱',
                                            'type' => 'string',
                                            'example' => '[email protected]',
                                        ],
                                        '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\\": \\"[email protected]\\",\\n      \\"SettleBasePrice\\": 0\\n    }\\n  ]\\n}","type":"json"}]',
            'title' => '查询需求详情列表',
        ],
        '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,
                        'docRequired' => true,
                        'example' => 'example.com',
                    ],
                ],
                [
                    'name' => 'Code',
                    'in' => 'query',
                    'schema' => [
                        'description' => '拓展字段,无需填写',
                        'type' => 'string',
                        'required' => false,
                        'example' => '无',
                    ],
                ],
                [
                    'name' => 'Source',
                    'in' => 'query',
                    'schema' => [
                        'description' => '订单来源,非必填,可以填入调用方名称',
                        'type' => 'string',
                        'required' => false,
                        'example' => 'partnername',
                    ],
                ],
                [
                    'name' => 'ContactId',
                    'in' => 'query',
                    'schema' => [
                        'description' => '已实名的联系人模板ID,域名交易成功后将过户至该已实名认证的域名信息模板下。可登录https://dc.console.aliyun.com/next/index#/info-stencil/infoStencil查询或创建已实名的信息模板',
                        'type' => 'string',
                        'required' => true,
                        'docRequired' => true,
                        'example' => '11935401',
                    ],
                ],
                [
                    'name' => 'ExpectedPrice',
                    'in' => 'query',
                    'schema' => [
                        'description' => '期望购买价格。该价格应为CheckSelectedDomainStatus接口查询出的Price字段。用于防止调用询价接口时的域名价格与域名下单时实际售卖价格不一致,造成扣款不符合客户预期的问题。',
                        'type' => 'number',
                        'format' => 'double',
                        'required' => true,
                        'docRequired' => true,
                        'example' => '20.00',
                    ],
                ],
            ],
            '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' => [
                                        'description' => '被阻塞交易的域名列表。',
                                        'type' => 'array',
                                        'items' => [
                                            'description' => '被阻塞交易的域名。',
                                            'type' => 'string',
                                            'example' => 'test.com',
                                        ],
                                    ],
                                    'BizIds' => [
                                        'title' => '业务ID映射',
                                        'description' => '业务ID列表。',
                                        'type' => 'object',
                                        'additionalProperties' => [
                                            'title' => '业务ID映射',
                                            'description' => '业务ID。',
                                            'type' => 'string',
                                            'example' => 'T2023122019031400****',
                                        ],
                                    ],
                                ],
                            ],
                            'HttpStatusCode' => [
                                'description' => 'HTTP状态码',
                                '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"}]',
            'title' => '购买一口价严选域名',
            'description' => '- 一口价(严选)域名支付后通常5个工作日内完成交付,届时将交付至个别情况可能超过5个工作日;'."\n"
                ."\n"
                .'- 一口价(严选)域名支付后订单为“处理中”状态,处理中的订单不支持退款申请;'."\n"
                ."\n"
                .'- 您可通过控制台-域名服务-我是买家-已买到的域名查看。若域名购买成功,则订单变为“成功”状态;'."\n"
                ."\n"
                .'- 若购买失败款项会退回。购买成功后,可在控制台费用中心申请发票。',
        ],
        'CheckSelectedDomainStatus' => [
            'summary' => '查询一口价严选商品状态与价格,结果等同于mi.aliyun.com域名交易首页检索结果',
            '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,
                        'docRequired' => true,
                        'example' => 'example.com',
                    ],
                ],
            ],
            '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否',
                                        'description' => '是否为溢价词域名,true是false否',
                                        'type' => 'boolean',
                                    ],
                                ],
                            ],
                            'HttpStatusCode' => [
                                'description' => 'HTTP状态码',
                                '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"}]',
            'title' => '查询一口价严选商品状态与价格',
        ],
        'SelectedDomainList' => [
            'summary' => '导出今日全量在售一口价严选域名列表',
            '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,
                        'docRequired' => true,
                        'example' => '20231109',
                    ],
                ],
            ],
            '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"}]',
            'title' => '在售一口价严选域名列表下载',
            'description' => '<notice>文件会在当天凌晨2点生成完毕,并对外提供下载;</notice>'."\n"
                .'<notice>文件数据包含当天凌晨1点前全部一口价严选在售域名;</notice>'."\n"
                .'> 文件格式如下,分别为域名、价格、注册日期、过期日、售卖截止时间(如果截止时间为99991231235959,即永不过期)、一口价类型标示(selected:一口价严选)'."\n"
                .'<details>'."\n"
                .'<summary>列表文件行内格式示例</summary>'."\n"
                .'aliyun.com 182.00 19990101000000 20220101000000 20210101000000 selected'."\n"
                .'</details>',
            'requestParamsDescription' => '比如今天是2023年11月9日,该入参只能填写为20231109。目前暂不支持获取当日前的在售信息列表。',
        ],
        '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' => '原币种,比如USD',
                        'type' => 'string',
                        'required' => true,
                        'example' => 'USD',
                    ],
                ],
                [
                    'name' => 'ToCurrency',
                    'in' => 'query',
                    'schema' => [
                        'description' => '目标币种,比如CNY',
                        '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"}]',
            'title' => '查询汇率',
            'description' => '分页查询竞拍域名列表',
        ],
    ],
    'endpoints' => [
        [
            'regionId' => 'cn-hangzhou',
            'endpoint' => 'domain.aliyuncs.com',
        ],
        [
            'regionId' => 'ap-southeast-1',
            'endpoint' => 'domain-intl.aliyuncs.com',
        ],
    ],
];