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
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
|
<?php return [
'version' => '1.0',
'info' => ['style' => 'RPC', 'product' => 'Workorder', 'version' => '2021-06-10'],
'directories' => ['GetTicket', 'ReplyTicket', 'CloseTicket', 'EvaluateTicket', 'ListTickets', 'ListTicketNotes', 'ListCategories', 'GetMqConsumerTag', 'ReopenTicket', 'GetAttachmentUploadUrl', 'CreateTicket', 'ListProducts'],
'components' => [
'schemas' => [],
],
'apis' => [
'CloseTicket' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'TicketId',
'in' => 'formData',
'schema' => ['description' => 'The ticket ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'G2BKRWG', 'title' => ''],
],
[
'name' => 'Uid',
'in' => 'formData',
'schema' => ['description' => 'The user UID. You can find your UID by clicking the profile picture in the upper-right corner of the DMS console.', 'type' => 'string', 'required' => false, 'example' => '1139477549527134', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => ['description' => 'Details about the permission error. An empty string is returned if you have the required permissions.', 'type' => 'string', 'example' => '{\\"AuthAction\\":\\"ram:CloseTicket\\",\\"AuthPrincipalDisplayName\\":\\"2146216584788xxxxx\\",\\"AuthPrincipalOwnerId\\":\\"1135850448xxxxx\\",\\"AuthPrincipalType\\":\\"SubUser\\",\\"NoPermissionType\\":\\"ImplicitDeny\\",\\"PolicyType\\":\\"AccountLevelIdentityBasedPolicy\\"}', 'title' => ''],
'Code' => ['description' => 'The return code of the request.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The error message. The message is returned if \\`Success\\` is \\`false\\`.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'RequestId' => ['description' => 'The unique request ID.', 'type' => 'string', 'example' => 'CA6204AC-6AA9-4CFA-9310-7DFD20C19EBC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the call was successful. A value of \\`true\\` indicates a successful call.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'param.illegal', 'errorMessage' => 'Params illegal.', 'description' => ''],
],
[
['errorCode' => 'illegal.auth', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => 'You are not authorized to perform this operation.'],
],
403 => [
['errorCode' => 'No permissions', 'errorMessage' => 'No permissions to access.', 'description' => 'RAM authentication does not have permission'],
],
500 => [
['errorCode' => 'System.error', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request. Please try again.'],
],
],
'title' => 'CloseTicket',
'summary' => 'Closes a ticket.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CloseTicket'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{\\\\\\\\\\\\\\"AuthAction\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ram:CloseTicket\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalDisplayName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2146216584788xxxxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalOwnerId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1135850448xxxxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"SubUser\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"NoPermissionType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ImplicitDeny\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"PolicyType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"AccountLevelIdentityBasedPolicy\\\\\\\\\\\\\\"}\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"CA6204AC-6AA9-4CFA-9310-7DFD20C19EBC\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'CreateTicket' => [
'summary' => 'Creates a ticket.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'Description',
'in' => 'formData',
'schema' => ['description' => 'The description of the issue in the ticket. Only plain text is supported.', 'type' => 'string', 'example' => 'ECS backup failed', 'required' => true, 'docRequired' => true, 'title' => ''],
],
[
'name' => 'Severity',
'in' => 'formData',
'schema' => [
'description' => 'An enumeration value. A value of 1 indicates a normal issue. A value of 2 indicates an urgent issue.',
'enumValueTitles' => [1 => 'Normal', 'Urgent'],
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'maximum' => '1000',
'minimum' => '0',
'example' => '1',
'title' => '',
],
],
[
'name' => 'CategoryId',
'in' => 'formData',
'schema' => ['description' => 'The ID of the issue category. Obtain this ID from the ListCategories operation.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '53812', 'title' => ''],
],
[
'name' => 'Title',
'in' => 'formData',
'schema' => ['description' => 'The title of the ticket.', 'type' => 'string', 'example' => 'ECS backup failed', 'required' => false, 'title' => ''],
],
[
'name' => 'CreatorId',
'in' => 'formData',
'schema' => ['description' => 'The Alibaba Cloud UID of the account that submits the ticket. This parameter is required for Marketplace reseller scenarios.', 'type' => 'string', 'required' => false, 'example' => '1289427240739141', 'title' => ''],
],
[
'name' => 'Email',
'in' => 'formData',
'schema' => ['description' => 'The contact email address for the ticket.', 'type' => 'string', 'required' => false, 'example' => 'sdahkjdshga@qq.com', 'title' => ''],
],
[
'name' => 'FileNameList',
'in' => 'formData',
'style' => 'simple',
'schema' => [
'description' => 'A list of attachment names. Use the ObjectKey value returned by the GetAttachmentUploadUrl operation.',
'type' => 'array',
'items' => ['description' => 'The ObjectKey value returned by the GetAttachmentUploadUrl operation.', 'type' => 'string', 'required' => false, 'example' => 'cabb80c3-430b-4079-a9f2-d2a0d1c2a587.png', 'title' => ''],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'SecretInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'Sensitive information.',
'type' => 'object',
'properties' => [
'Content' => ['description' => 'The text of the sensitive information.', 'type' => 'string', 'example' => 'ID card: 3310xxxx', 'required' => false, 'title' => ''],
'FileNameList' => [
'description' => 'A list of attachment names for the sensitive information.',
'type' => 'array',
'items' => ['description' => 'The ObjectKey value returned by the GetAttachmentUploadUrl operation.', 'type' => 'string', 'required' => false, 'example' => 'cabb80c3-430b-4079-a9f2-d2a0d1c2a587.png', 'title' => ''],
'required' => false,
'title' => '',
'example' => '',
],
],
'required' => false,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => ['description' => 'The details of the permission error. An empty string is returned if the permissions are sufficient.', 'type' => 'string', 'example' => '{\\"AuthAction\\":\\"ram:CreateTicket\\",\\"AuthPrincipalDisplayName\\":\\"2146216584788xxxxx\\",\\"AuthPrincipalOwnerId\\":\\"1135850448xxxxx\\",\\"AuthPrincipalType\\":\\"SubUser\\",\\"NoPermissionType\\":\\"ImplicitDeny\\",\\"PolicyType\\":\\"AccountLevelIdentityBasedPolicy\\"}', 'title' => ''],
'Code' => ['description' => 'The return code of the API request.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'Message' => ['description' => 'The error message. This parameter is returned when the value of Success is false.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'Data' => ['description' => 'The return value, which is the ticket ID.', 'type' => 'string', 'example' => '0005PYGCW', 'title' => ''],
'RequestId' => ['description' => 'The unique ID of the request. Each request has a unique ID.', 'type' => 'string', 'example' => '0254B7DE-7365-57B4-8E38-14FE927E3FEB', 'title' => ''],
'Success' => ['description' => 'Indicates whether the API call was successful. A value of true indicates that the call was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'param.illegal', 'errorMessage' => 'Params illegal.', 'description' => ''],
],
[
['errorCode' => 'illegal.auth', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => 'You are not authorized to perform this operation.'],
],
403 => [
['errorCode' => 'No permissions', 'errorMessage' => 'No permissions to access.', 'description' => 'RAM authentication does not have permission'],
],
500 => [
['errorCode' => 'System.error', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request. Please try again.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{\\\\\\\\\\\\\\"AuthAction\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ram:CreateTicket\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalDisplayName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2146216584788xxxxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalOwnerId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1135850448xxxxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"SubUser\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"NoPermissionType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ImplicitDeny\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"PolicyType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"AccountLevelIdentityBasedPolicy\\\\\\\\\\\\\\"}\\",\\n \\"Code\\": 0,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": \\"0005PYGCW\\",\\n \\"RequestId\\": \\"0254B7DE-7365-57B4-8E38-14FE927E3FEB\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => 'CreateTicket',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateTicket'],
],
],
'translator' => 'manual',
],
'EvaluateTicket' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'TicketId',
'in' => 'formData',
'schema' => ['description' => 'The ticket ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '001ET1BU1P', 'title' => ''],
],
[
'name' => 'Solved',
'in' => 'formData',
'schema' => ['description' => 'Indicates whether the issue was resolved.', 'type' => 'boolean', 'required' => true, 'example' => 'true', 'title' => ''],
],
[
'name' => 'Score',
'in' => 'formData',
'schema' => ['description' => 'The rating, from 1 to 5 stars.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''],
],
[
'name' => 'Content',
'in' => 'formData',
'schema' => ['description' => 'The content of the evaluation.', 'type' => 'string', 'example' => 'Very satisfactory support experience', 'required' => false, 'title' => ''],
],
[
'name' => 'Uid',
'in' => 'formData',
'schema' => ['description' => 'The UID.', 'type' => 'string', 'required' => false, 'example' => '1902070573958003', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => ['description' => 'The details of the permission error. An empty string is returned if you have the required permissions.', 'type' => 'string', 'example' => '{\\"AuthAction\\":\\"ram:EvaluateTicket\\",\\"AuthPrincipalDisplayName\\":\\"2146216584788xxxxx\\",\\"AuthPrincipalOwnerId\\":\\"1135850448xxxxx\\",\\"AuthPrincipalType\\":\\"SubUser\\",\\"NoPermissionType\\":\\"ImplicitDeny\\",\\"PolicyType\\":\\"AccountLevelIdentityBasedPolicy\\"}', 'title' => ''],
'Code' => ['description' => 'The status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The error message. This parameter is returned only when the \\`Success\\` parameter is \\`false\\`.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C1DA4C6F-963E-5741-AB57-67A554D102FD', 'title' => ''],
'Success' => ['description' => 'Indicates whether the call was successful. A value of \\`true\\` indicates that the call succeeded. A value of \\`false\\` indicates that the call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'param.illegal', 'errorMessage' => 'Params illegal.', 'description' => ''],
],
[
['errorCode' => 'illegal.auth', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => 'You are not authorized to perform this operation.'],
],
403 => [
['errorCode' => 'No permissions', 'errorMessage' => 'No permissions to access.', 'description' => 'RAM authentication does not have permission'],
],
500 => [
['errorCode' => 'System.error', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request. Please try again.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{\\\\\\\\\\\\\\"AuthAction\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ram:EvaluateTicket\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalDisplayName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2146216584788xxxxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalOwnerId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1135850448xxxxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"SubUser\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"NoPermissionType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ImplicitDeny\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"PolicyType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"AccountLevelIdentityBasedPolicy\\\\\\\\\\\\\\"}\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"C1DA4C6F-963E-5741-AB57-67A554D102FD\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => 'EvaluateTicket',
'summary' => 'Evaluates a ticket.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 60, 'regionId' => '*', 'api' => 'EvaluateTicket'],
],
],
'translator' => 'manual',
],
'GetAttachmentUploadUrl' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'FileName',
'in' => 'formData',
'schema' => ['description' => 'Name of the uploaded file', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '81A0D93D-54D7-4529-ABFA-633ED63223BA.jpg', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'Message' => ['description' => 'The error message. If success is set to false, the message is returned.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ED195C2C-787F-511C-8204-714456781861', 'title' => ''],
'Success' => ['description' => 'Indicates whether the call is successful. A value of true indicates that the call is normal.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
'description' => 'The data returned after the call succeeds.',
'type' => 'object',
'properties' => [
'ObjectKey' => ['description' => 'Uploaded file identifier', 'type' => 'string', 'example' => 'cdb5d174-c282-4b2d-9048-e74ea2223127.jpg', 'title' => ''],
'PutSignedUrl' => ['description' => 'The signed URL used to upload the object to OSS.', 'type' => 'string', 'example' => 'https://workorder.oss-cn-beijing.aliyuncs.com'."\n"
.'/20220314/cabb80c3-430b-4079-a9f2-d2a0d1c2a587.png?Expires=1647328689&OSSAccessKeyId=LTAI***************&Signature=AbSEh26G3oYrJ8ivr4B0xzF89zk%3D', 'title' => ''],
'GetSignedUrl' => ['description' => 'Query the signed URL of an OSS object', 'type' => 'string', 'example' => 'https://workorder.oss-cn-beijing.aliyuncs.com'."\n"
.'/20220314/cabb80c3-430b-4079-a9f2-d2a0d1c2a587.png?Expires=1647328689&OSSAccessKeyId=LTAI**************&Signature=AbSEh26G3oYrJ8ivr4B0xzF89zk%3D', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'param.illegal', 'errorMessage' => 'Params illegal.', 'description' => ''],
],
[
['errorCode' => 'illegal.auth', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => 'You are not authorized to perform this operation.'],
],
403 => [
['errorCode' => 'No permissions', 'errorMessage' => 'No permissions to access.', 'description' => 'RAM authentication does not have permission'],
],
500 => [
['errorCode' => 'System.error', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request. Please try again.'],
],
],
'title' => 'GetAttachmentUploadUrl',
'summary' => 'Queries the Object Storage Service (OSS) URL that is used to upload attachments.',
'description' => '> Attachment upload'."\n"
.'>'."\n"
.'> - Use a presigned URL to upload the file. For more information, see the OSS documentation.'."\n"
."\n"
.'After you obtain the temporary upload URL, you can upload the file as follows:'."\n"
."\n"
.'<details>'."\n"
."\n"
.'<summary>'."\n"
."\n"
.'Sample'."\n"
."\n"
.'</summary>'."\n"
."\n"
.'curl -X PUT -H "Content-Type:application/octet-stream" -H "x-oss-meta-author:aliy" -T /home/admin/file.png "https\\://xx.oss-cn-zhangjiakou.aliyuncs.com/xx/xx.png"'."\n"
."\n"
.'</details>',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetAttachmentUploadUrl'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 0,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"ED195C2C-787F-511C-8204-714456781861\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"ObjectKey\\": \\"cdb5d174-c282-4b2d-9048-e74ea2223127.jpg\\",\\n \\"PutSignedUrl\\": \\"https://workorder.oss-cn-beijing.aliyuncs.com\\\\n/20220314/cabb80c3-430b-4079-a9f2-d2a0d1c2a587.png?Expires=1647328689&OSSAccessKeyId=LTAI***************&Signature=AbSEh26G3oYrJ8ivr4B0xzF89zk%3D\\",\\n \\"GetSignedUrl\\": \\"https://workorder.oss-cn-beijing.aliyuncs.com\\\\n/20220314/cabb80c3-430b-4079-a9f2-d2a0d1c2a587.png?Expires=1647328689&OSSAccessKeyId=LTAI**************&Signature=AbSEh26G3oYrJ8ivr4B0xzF89zk%3D\\"\\n }\\n}","type":"json"}]',
],
'GetMqConsumerTag' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'tenantRelevance' => 'publicInformation'],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => ['description' => 'The details of the permission error. An empty string is returned if you have the required permissions.', 'type' => 'string', 'example' => '{\\"AuthAction\\":\\"ram:GetMqConsumerTag\\",\\"AuthPrincipalDisplayName\\":\\"2146216584788xxxxx\\",\\"AuthPrincipalOwnerId\\":\\"1135850448xxxxx\\",\\"AuthPrincipalType\\":\\"SubUser\\",\\"NoPermissionType\\":\\"ImplicitDeny\\",\\"PolicyType\\":\\"AccountLevelIdentityBasedPolicy\\"}', 'title' => ''],
'Code' => ['description' => 'The return code of the API request.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The error message. This parameter is returned when \\`success\\` is \\`false\\`.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'Data' => ['description' => 'The return value. This is the unique tag for your Message Queue (MQ) consumer.', 'type' => 'string', 'example' => '46434030', 'title' => ''],
'RequestId' => ['description' => 'The unique identifier of the request.', 'type' => 'string', 'example' => 'CA6204AC-6AA9-4CFA-9310-7DFD20C19EBC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the call was successful. A value of \\`true\\` indicates success. A value of \\`false\\` indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'param.illegal', 'errorMessage' => 'Params illegal.', 'description' => ''],
],
[
['errorCode' => 'illegal.auth', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => 'You are not authorized to perform this operation.'],
],
403 => [
['errorCode' => 'No permissions', 'errorMessage' => 'No permissions to access.', 'description' => 'RAM authentication does not have permission'],
],
500 => [
['errorCode' => 'System.error', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request. Please try again.'],
],
],
'title' => 'GetMqConsumerTag',
'summary' => 'Retrieves the tag for a ticket\'s RocketMQ message listener.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetMqConsumerTag'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{\\\\\\\\\\\\\\"AuthAction\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ram:GetMqConsumerTag\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalDisplayName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2146216584788xxxxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalOwnerId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1135850448xxxxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"SubUser\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"NoPermissionType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ImplicitDeny\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"PolicyType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"AccountLevelIdentityBasedPolicy\\\\\\\\\\\\\\"}\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": \\"46434030\\",\\n \\"RequestId\\": \\"CA6204AC-6AA9-4CFA-9310-7DFD20C19EBC\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'GetTicket' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'TicketId',
'in' => 'formData',
'schema' => ['description' => 'The ticket ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '001571BTXC', 'title' => ''],
],
[
'name' => 'Uid',
'in' => 'formData',
'schema' => ['description' => 'The UID.', 'type' => 'string', 'required' => false, 'example' => '1604499804113750', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => ['description' => 'The details of the access denial. An empty string is returned if you have sufficient permissions.', 'type' => 'string', 'example' => '{\\"AuthAction\\":\\"ram:GetTicket\\",\\"AuthPrincipalDisplayName\\":\\"2146216584788xxxxx\\",\\"AuthPrincipalOwnerId\\":\\"1135850448xxxxx\\",\\"AuthPrincipalType\\":\\"SubUser\\",\\"NoPermissionType\\":\\"ImplicitDeny\\",\\"PolicyType\\":\\"AccountLevelIdentityBasedPolicy\\"}', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C499BB0F-630D-5BE6-B3EA-5FCD95B85503', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful. A value of true indicates success.', 'type' => 'boolean', 'example' => 'True', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'Message' => ['description' => 'The error message. Returned only when Success is false.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'TotalCount' => ['description' => 'The total number of tickets.', 'type' => 'integer', 'format' => 'int64', 'example' => '108', 'title' => ''],
'Data' => [
'description' => 'The data returned on success.',
'type' => 'object',
'properties' => [
'TicketId' => ['description' => 'The ticket ID.', 'type' => 'string', 'example' => '0005PYGCW', 'title' => ''],
'Title' => ['description' => 'The ticket title.', 'type' => 'string', 'example' => 'Why did ECS renewal fail?', 'title' => ''],
'Description' => ['description' => 'The description of the ticket. Only plain text is supported.', 'type' => 'string', 'example' => 'Why ECS renewal failed?', 'title' => ''],
'CreateTime' => ['description' => 'The UNIX timestamp when the ticket was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1623396736000', 'title' => ''],
'CreatorId' => ['description' => 'The UID of the user who created the ticket.', 'type' => 'string', 'example' => '1168025', 'title' => ''],
'CategoryId' => ['description' => 'The ID of the ticket category.', 'type' => 'string', 'example' => '7161', 'title' => ''],
'Status' => [
'description' => 'The status of the ticket. The following are the valid values:'."\n"
."\n"
.'1: assigned (To be processed)'."\n"
."\n"
.'2: dealing (Processing)'."\n"
."\n"
.'3: wait\\_feedback (Waiting for feedback)'."\n"
."\n"
.'4: feedback (Feedback received)'."\n"
."\n"
.'5: wait\\_confirm (To be confirmed)'."\n"
."\n"
.'6: confirmed (Completed)',
'type' => 'object',
'properties' => [
'Label' => ['description' => 'The status label.', 'type' => 'string', 'example' => 'Completed', 'title' => ''],
'Value' => ['description' => 'The status value.', 'type' => 'string', 'example' => '6', 'title' => ''],
],
'title' => '',
'example' => '',
],
'Severity' => [
'description' => 'The severity level. A value of 1 indicates a common issue. A value of 2 indicates an urgent issue.',
'type' => 'object',
'properties' => [
'Label' => ['description' => 'The severity label.', 'type' => 'string', 'example' => 'General issue', 'title' => ''],
'Value' => ['description' => 'The severity value.', 'type' => 'string', 'example' => '1', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'illegal.param', 'errorMessage' => 'Illegal param.', 'description' => ''],
],
[
['errorCode' => 'illegal.auth', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => 'You are not authorized to perform this operation.'],
],
403 => [
['errorCode' => 'No permissions', 'errorMessage' => 'No permissions to access.', 'description' => 'RAM authentication does not have permission'],
],
500 => [
['errorCode' => 'System.error', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request. Please try again.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{\\\\\\\\\\\\\\"AuthAction\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ram:GetTicket\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalDisplayName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2146216584788xxxxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalOwnerId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1135850448xxxxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"SubUser\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"NoPermissionType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ImplicitDeny\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"PolicyType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"AccountLevelIdentityBasedPolicy\\\\\\\\\\\\\\"}\\",\\n \\"RequestId\\": \\"C499BB0F-630D-5BE6-B3EA-5FCD95B85503\\",\\n \\"Success\\": true,\\n \\"Code\\": 0,\\n \\"Message\\": \\"success\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 108,\\n \\"Data\\": {\\n \\"TicketId\\": \\"0005PYGCW\\",\\n \\"Title\\": \\"Why did ECS renewal fail?\\",\\n \\"Description\\": \\"Why ECS renewal failed?\\",\\n \\"CreateTime\\": 1623396736000,\\n \\"CreatorId\\": \\"1168025\\",\\n \\"CategoryId\\": \\"7161\\",\\n \\"Status\\": {\\n \\"Label\\": \\"Completed\\",\\n \\"Value\\": \\"6\\"\\n },\\n \\"Severity\\": {\\n \\"Label\\": \\"General issue\\",\\n \\"Value\\": \\"1\\"\\n }\\n }\\n}","type":"json"}]',
'title' => 'GetTicket',
'summary' => 'Queries a ticket.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '256', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetTicket'],
],
],
'translator' => 'manual',
],
'ListCategories' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'ProductId',
'in' => 'formData',
'schema' => ['description' => 'The ID of the product. You can call the ListProducts operation to obtain the product ID. The ProductId parameter is the ID of an Alibaba Cloud product. Multiple Categories are displayed for each product.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '99999999999', 'minimum' => '0', 'example' => '18550', 'title' => ''],
],
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['description' => 'The name of the classification question. Fuzzy search is supported.', 'type' => 'string', 'required' => false, 'example' => 'ecs', 'title' => ''],
],
[
'name' => 'Language',
'in' => 'query',
'schema' => ['description' => 'Multi-language, support, Chinese, English. Value definition: zh: Chinese, en: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The error message. If success is set to false, the message is returned.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CA6204AC-6AA9-4CFA-9310-7DFD20C19EBC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful. Valid values: The value true indicates a success. The value false indicates a failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
'description' => 'The return value, which is a list of question categories',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'CategoryName' => ['description' => 'The name of the ticket issue category.', 'type' => 'string', 'example' => 'ECS', 'title' => ''],
'CategoryId' => ['description' => 'The ID of the ticket issue category.', 'type' => 'integer', 'format' => 'int64', 'example' => '7161', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'param.illegal', 'errorMessage' => 'Params illegal.', 'description' => ''],
],
[
['errorCode' => 'illegal.auth', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => 'You are not authorized to perform this operation.'],
],
403 => [
['errorCode' => 'No permissions', 'errorMessage' => 'No permissions to access.', 'description' => 'RAM authentication does not have permission'],
],
500 => [
['errorCode' => 'System.error', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request. Please try again.'],
],
],
'title' => 'ListCategories',
'summary' => 'Obtains the list data of ticket problem categories.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListCategories'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"CA6204AC-6AA9-4CFA-9310-7DFD20C19EBC\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"CategoryName\\": \\"ECS\\",\\n \\"CategoryId\\": 7161\\n }\\n ]\\n}","type":"json"}]',
],
'ListProducts' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => 'The name of the product. Fuzzy search is supported. This parameter is optional.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'ecs', 'title' => ''],
],
[
'name' => 'Language',
'in' => 'query',
'schema' => ['description' => 'The language that you use, supporting English, Chinese, and Japanese. Valid values: en, zh, and jp, which indicate English, Chinese, and Japanese, respectively.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The return code of the request result.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'Message' => ['description' => 'The error message. If success is set to false, the message is returned.', 'type' => 'string', 'example' => 'Invalid input parameter', 'title' => ''],
'RequestId' => ['description' => 'The unique ID of the API request. The requestID is unique for each call.', 'type' => 'string', 'example' => 'AC0AB2EC-AFBC-44BA-AE77-132A5A1EC0AD', 'title' => ''],
'Success' => ['description' => 'Indicates whether the call is successful. A value of true indicates that the call is normal.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
'description' => 'Return value, that is, product list',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DirectoryId' => ['description' => 'The ID of the product catalog, which represents the product category, such as elastic computing', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
'DirectoryName' => ['description' => 'The name of the product catalog, which represents the product category, such as elastic computing', 'type' => 'string', 'example' => 'ECS', 'title' => ''],
'ProductList' => [
'description' => 'List of Alibaba Cloud products',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ProductId' => ['description' => 'Alibaba Cloud product ID', 'type' => 'integer', 'format' => 'int64', 'example' => '7160', 'title' => ''],
'ProductName' => ['description' => 'Alibaba Cloud product name', 'type' => 'string', 'example' => 'ECS', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'param.illegal', 'errorMessage' => 'Params illegal.', 'description' => ''],
],
[
['errorCode' => 'illegal.auth', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => 'You are not authorized to perform this operation.'],
],
403 => [
['errorCode' => 'No permissions', 'errorMessage' => 'No permissions to access.', 'description' => 'RAM authentication does not have permission'],
],
500 => [
['errorCode' => 'System.error', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request. Please try again.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 0,\\n \\"Message\\": \\"Invalid input parameter\\",\\n \\"RequestId\\": \\"AC0AB2EC-AFBC-44BA-AE77-132A5A1EC0AD\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"DirectoryId\\": 1,\\n \\"DirectoryName\\": \\"ECS\\",\\n \\"ProductList\\": [\\n {\\n \\"ProductId\\": 7160,\\n \\"ProductName\\": \\"ECS\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
'title' => 'ListProducts',
'summary' => 'Obtains the data of the Alibaba Cloud product list.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListProducts'],
],
],
'translator' => 'manual',
],
'ListTicketNotes' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'TicketId',
'in' => 'query',
'schema' => ['description' => 'The ticket ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0005PYGCW', 'title' => ''],
],
[
'name' => 'Uid',
'in' => 'query',
'schema' => ['description' => 'The UID.', 'type' => 'string', 'required' => false, 'example' => '1936753548534516', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => ['description' => 'The details of the permission error. An empty string is returned if you have the required permissions.', 'type' => 'string', 'example' => '{\\"AuthAction\\":\\"ram:ListTicketNotes\\",\\"AuthPrincipalDisplayName\\":\\"2146216584788xxxxx\\",\\"AuthPrincipalOwnerId\\":\\"1135850448xxxxx\\",\\"AuthPrincipalType\\":\\"SubUser\\",\\"NoPermissionType\\":\\"ImplicitDeny\\",\\"PolicyType\\":\\"AccountLevelIdentityBasedPolicy\\"}', 'title' => ''],
'Code' => ['description' => 'The return code for the API request.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'Message' => ['description' => 'The error message. This parameter is returned when \\`Success\\` is \\`false\\`.', 'type' => 'string', 'example' => 'Invalid input parameter', 'title' => ''],
'RequestId' => ['description' => 'The unique ID of the request. Each request has a unique ID.', 'type' => 'string', 'example' => 'AC0AB2EC-AFBC-44BA-AE77-132A5A1EC0AD', 'title' => ''],
'Success' => ['description' => 'Indicates whether the call was successful. A value of \\`true\\` indicates a successful call.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
'description' => 'The return value, which is a list of communication records for the specified ticket.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => ['description' => 'The type of communication. Valid values: \\`1\\`: Card, which corresponds to \\`Schema\\`. \\`2\\`: Text, which corresponds to \\`Content\\`.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'Status' => ['description' => 'The status of the communication message. Valid values: \\`1\\`: Unread. \\`2\\`: Read.', 'type' => 'integer', 'format' => 'int32', 'example' => '6', 'title' => ''],
'Tip' => ['description' => 'This parameter is not in use.', 'type' => 'string', 'example' => 'null', 'title' => ''],
'DialogId' => ['description' => 'The unique ID of the communication record.', 'type' => 'integer', 'format' => 'int64', 'example' => '9999', 'title' => ''],
'CreateTime' => ['description' => 'The UNIX timestamp when the communication message was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1623396736000', 'title' => ''],
'Dialog' => [
'description' => 'The ticket communication record object.',
'type' => 'object',
'properties' => [
'Schema' => ['description' => 'The system card for the ticket communication record. This parameter is reserved for future use. Currently, you can use the \\`Content\\` parameter to retrieve the plain text.', 'type' => 'string', 'example' => 'null', 'title' => ''],
'Content' => ['description' => 'The content of the ticket communication.', 'type' => 'string', 'example' => 'Hello, my ECS renewal failed. What is the reason?', 'title' => ''],
],
'title' => '',
'example' => '',
],
'User' => [
'description' => 'The user in the communication.',
'type' => 'object',
'properties' => [
'Role' => ['description' => 'The role of the user in the communication. This parameter distinguishes between customer service agents and customers. Valid values: \\`2\\`: Customer service agent. \\`3\\`: Customer.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
'Name' => ['description' => 'The name of the user.', 'type' => 'string', 'example' => 'John', 'title' => ''],
],
'title' => '',
'example' => '',
],
'Attachments' => [
'description' => 'The list of attachments.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => ['description' => 'The name of the attachment.', 'type' => 'string', 'example' => '003.jpg', 'title' => ''],
'Url' => ['description' => 'A temporary URL to access the attachment.', 'type' => 'string', 'example' => 'https://gts-workorder.oss-cn-beijing.aliyuncs.com/20221003/cbc00fb0-b612-4d89-a75b-8d535f750f9f/image.png', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'param.illegal', 'errorMessage' => 'Params illegal.', 'description' => ''],
],
[
['errorCode' => 'illegal.auth', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => 'You are not authorized to perform this operation.'],
],
403 => [
['errorCode' => 'No permissions', 'errorMessage' => 'No permissions to access.', 'description' => 'RAM authentication does not have permission'],
],
500 => [
['errorCode' => 'System.error', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request. Please try again.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{\\\\\\\\\\\\\\"AuthAction\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ram:ListTicketNotes\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalDisplayName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2146216584788xxxxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalOwnerId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1135850448xxxxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"SubUser\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"NoPermissionType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ImplicitDeny\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"PolicyType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"AccountLevelIdentityBasedPolicy\\\\\\\\\\\\\\"}\\",\\n \\"Code\\": 0,\\n \\"Message\\": \\"Invalid input parameter\\",\\n \\"RequestId\\": \\"AC0AB2EC-AFBC-44BA-AE77-132A5A1EC0AD\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Type\\": 1,\\n \\"Status\\": 6,\\n \\"Tip\\": \\"null\\",\\n \\"DialogId\\": 9999,\\n \\"CreateTime\\": 1623396736000,\\n \\"Dialog\\": {\\n \\"Schema\\": \\"null\\",\\n \\"Content\\": \\"Hello, my ECS renewal failed. What is the reason?\\"\\n },\\n \\"User\\": {\\n \\"Role\\": 3,\\n \\"Name\\": \\"John\\"\\n },\\n \\"Attachments\\": [\\n {\\n \\"Name\\": \\"003.jpg\\",\\n \\"Url\\": \\"https://gts-workorder.oss-cn-beijing.aliyuncs.com/20221003/cbc00fb0-b612-4d89-a75b-8d535f750f9f/image.png\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
'title' => 'ListTicketNotes',
'summary' => 'Retrieves the communication records for a ticket.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '256', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListTicketNotes'],
],
],
'translator' => 'manual',
],
'ListTickets' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'StartDate',
'in' => 'formData',
'schema' => ['description' => 'The start time when the ticket was created. Use this parameter with EndDate to query tickets created within a specific time range.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '1623396736000', 'title' => ''],
],
[
'name' => 'EndDate',
'in' => 'formData',
'schema' => ['description' => 'The end time when the ticket was created. Use this parameter with StartDate to query tickets created within a specific time range.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '1623396736000', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The page number for a paged query.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '9999999', 'minimum' => '1', 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '10', 'example' => '10', 'title' => ''],
],
[
'name' => 'TicketId',
'in' => 'formData',
'schema' => ['description' => 'The ticket ID.', 'type' => 'string', 'required' => false, 'example' => '0005PYGCW', 'title' => ''],
],
[
'name' => 'Keyword',
'in' => 'formData',
'schema' => ['description' => 'The keyword for a fuzzy search. The keyword is used to match the content of the Description field of the ticket.', 'type' => 'string', 'required' => false, 'example' => 'ecs', 'title' => ''],
],
[
'name' => 'StatusList',
'in' => 'formData',
'style' => 'repeatList',
'schema' => [
'description' => 'A list of ticket statuses.',
'type' => 'array',
'items' => ['description' => 'The ticket status. Valid values: assigned (Pending response), dealing (In progress), wait\\_feedback (Waiting for feedback), feedback (Feedback received), wait\\_confirm (Pending confirmation), and confirmed (Completed).', 'type' => 'string', 'required' => false, 'example' => 'confirmed', 'title' => ''],
'required' => false,
'example' => '6',
'maxItems' => 11,
'title' => '',
],
],
[
'name' => 'TicketIdList',
'in' => 'formData',
'style' => 'simple',
'schema' => [
'description' => 'A list of ticket IDs.',
'type' => 'array',
'items' => ['description' => 'The ticket ID.', 'type' => 'string', 'required' => false, 'example' => '0006S6ZL6E', 'title' => ''],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'Uid',
'in' => 'formData',
'schema' => ['description' => 'The UID.', 'type' => 'string', 'required' => false, 'example' => '1902070573958003', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => ['description' => 'The details of the permission error. If you have the required permissions, an empty string is returned.', 'type' => 'string', 'example' => '{\\"AuthAction\\":\\"ram:ListTickets\\",\\"AuthPrincipalDisplayName\\":\\"2146216584788xxxxx\\",\\"AuthPrincipalOwnerId\\":\\"1135850448xxxxx\\",\\"AuthPrincipalType\\":\\"SubUser\\",\\"NoPermissionType\\":\\"ImplicitDeny\\",\\"PolicyType\\":\\"AccountLevelIdentityBasedPolicy\\"}', 'title' => ''],
'RequestId' => ['description' => 'The unique ID of the request. A unique ID is returned for each request.', 'type' => 'string', 'example' => 'AC0AB2EC-AFBC-44BA-AE77-132A5A1EC0AD', 'title' => ''],
'Success' => ['description' => 'Indicates whether the call was successful. A value of true indicates that the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Code' => ['description' => 'The return code of the request.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'Message' => ['description' => 'The error message. This parameter is returned only when the value of success is false.', 'type' => 'string', 'example' => '入参解析失败', 'title' => ''],
'PageNumber' => ['description' => 'The page number of the paged query.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries returned on each page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'TotalCount' => ['description' => 'The total number of query results, which is the total number of your tickets.', 'type' => 'integer', 'format' => 'int64', 'example' => '99', 'title' => ''],
'Data' => [
'description' => 'The list of your tickets.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TicketId' => ['description' => 'The ticket ID.', 'type' => 'string', 'example' => '0005PYGCW', 'title' => ''],
'Title' => ['description' => 'The ticket title.', 'type' => 'string', 'example' => 'Why did ECS renewal fail?', 'title' => ''],
'Status' => [
'description' => 'The ticket status. Valid values: assigned (Pending response), dealing (In progress), wait\\_feedback (Waiting for feedback), feedback (Feedback received), wait\\_confirm (Pending confirmation), and confirmed (Completed).',
'type' => 'object',
'properties' => [
'Label' => ['description' => 'The description of the status. Example: Completed.', 'type' => 'string', 'example' => 'Completed', 'title' => ''],
'Value' => ['description' => 'The value of the status. For example, a value of 6 indicates that the ticket is completed.', 'type' => 'string', 'example' => '6', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'illegal.param', 'errorMessage' => 'Params illegal', 'description' => ''],
],
[
['errorCode' => 'illegal.auth', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => 'You are not authorized to perform this operation.'],
],
403 => [
['errorCode' => 'No permissions', 'errorMessage' => 'No permissions to access.', 'description' => 'RAM authentication does not have permission'],
],
500 => [
['errorCode' => 'System.error', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request. Please try again.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{\\\\\\\\\\\\\\"AuthAction\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ram:ListTickets\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalDisplayName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2146216584788xxxxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalOwnerId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1135850448xxxxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"SubUser\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"NoPermissionType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ImplicitDeny\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"PolicyType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"AccountLevelIdentityBasedPolicy\\\\\\\\\\\\\\"}\\",\\n \\"RequestId\\": \\"AC0AB2EC-AFBC-44BA-AE77-132A5A1EC0AD\\",\\n \\"Success\\": true,\\n \\"Code\\": 0,\\n \\"Message\\": \\"入参解析失败\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 99,\\n \\"Data\\": [\\n {\\n \\"TicketId\\": \\"0005PYGCW\\",\\n \\"Title\\": \\"Why did ECS renewal fail?\\",\\n \\"Status\\": {\\n \\"Label\\": \\"Completed\\",\\n \\"Value\\": \\"6\\"\\n }\\n }\\n ]\\n}","type":"json"}]',
'title' => 'ListTickets',
'summary' => 'Retrieves a list of your tickets.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListTickets'],
],
],
'translator' => 'manual',
],
'ReopenTicket' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'TicketId',
'in' => 'formData',
'schema' => ['description' => 'The ticket ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0005PYGCW', 'title' => ''],
],
[
'name' => 'Content',
'in' => 'formData',
'schema' => ['description' => 'The content of the reply to reopen the ticket.', 'type' => 'string', 'example' => 'The issue has not been resolved yet.', 'required' => true, 'docRequired' => true, 'title' => ''],
],
[
'name' => 'Uid',
'in' => 'formData',
'schema' => ['description' => 'The UID.', 'type' => 'string', 'required' => false, 'example' => '1013872004421947', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => ['description' => 'The details of the permission error. If you have the required permissions, an empty string is returned.', 'type' => 'string', 'example' => '{\\"AuthAction\\":\\"ram:ReopenTicket\\",\\"AuthPrincipalDisplayName\\":\\"2146216584788xxxxx\\",\\"AuthPrincipalOwnerId\\":\\"1135850448xxxxx\\",\\"AuthPrincipalType\\":\\"SubUser\\",\\"NoPermissionType\\":\\"ImplicitDeny\\",\\"PolicyType\\":\\"AccountLevelIdentityBasedPolicy\\"}', 'title' => ''],
'Code' => ['description' => 'The return code of the API request.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'Message' => ['description' => 'The error message. This parameter is returned when success is false.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'Data' => ['description' => 'The business data returned after the call is successful.', 'type' => 'string', 'example' => '0005PYGCW', 'title' => ''],
'RequestId' => ['description' => 'The unique ID that is generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'C1DA4C6F-963E-5741-AB57-67A554D102FD', 'title' => ''],
'Success' => ['description' => 'Indicates whether the API call was successful. A value of true indicates that the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'param.illegal', 'errorMessage' => 'Params illegal.', 'description' => ''],
],
[
['errorCode' => 'illegal.auth', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => 'You are not authorized to perform this operation.'],
],
403 => [
['errorCode' => 'No permissions', 'errorMessage' => 'No permissions to access.', 'description' => 'RAM authentication does not have permission'],
],
500 => [
['errorCode' => 'System.error', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request. Please try again.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{\\\\\\\\\\\\\\"AuthAction\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ram:ReopenTicket\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalDisplayName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2146216584788xxxxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalOwnerId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1135850448xxxxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"SubUser\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"NoPermissionType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ImplicitDeny\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"PolicyType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"AccountLevelIdentityBasedPolicy\\\\\\\\\\\\\\"}\\",\\n \\"Code\\": 0,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": \\"0005PYGCW\\",\\n \\"RequestId\\": \\"C1DA4C6F-963E-5741-AB57-67A554D102FD\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => 'ReopenTicket',
'summary' => 'Reopens a ticket.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ReopenTicket'],
],
],
'translator' => 'manual',
],
'ReplyTicket' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'TicketId',
'in' => 'formData',
'schema' => ['description' => 'The ticket ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0005PYGCW', 'title' => ''],
],
[
'name' => 'Content',
'in' => 'formData',
'schema' => ['description' => 'The content of the reply to the ticket.', 'type' => 'string', 'example' => 'OK, the renewal was successful on my end.', 'required' => true, 'docRequired' => true, 'title' => ''],
],
[
'name' => 'FileNameList',
'in' => 'query',
'style' => 'simple',
'schema' => [
'description' => 'A list of attachment names. This is the ObjectKey field returned by the GetAttachmentUploadUrl operation.',
'type' => 'array',
'items' => ['description' => 'The ObjectKey field returned by the GetAttachmentUploadUrl operation.', 'type' => 'string', 'required' => false, 'example' => '6bc06f96-f8c1-4c00-9e30-368444fbd025.jpg,', 'title' => ''],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'Encrypt',
'in' => 'formData',
'schema' => ['description' => 'Specifies whether to encrypt the content.', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'false', 'title' => ''],
],
[
'name' => 'Uid',
'in' => 'formData',
'schema' => ['description' => 'The Alibaba Cloud account ID (UID).', 'type' => 'string', 'required' => false, 'example' => '1289427240739141', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'Message' => ['description' => 'The error message. This parameter is returned when the value of Success is false.', 'type' => 'string', 'example' => 'Invalid input parameters', 'title' => ''],
'Data' => ['description' => 'The dialog ID of the ticket reply.', 'type' => 'string', 'example' => '46434030', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'C1DA4C6F-963E-5741-AB57-67A554D102FD', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'AccessDeniedDetail' => ['description' => 'The detailed information about the permission error. If you have the required permissions, an empty string is returned.', 'type' => 'string', 'example' => '{\\"AuthAction\\":\\"ram:ReplyTicket\\",\\"AuthPrincipalDisplayName\\":\\"2146216584788xxxxx\\",\\"AuthPrincipalOwnerId\\":\\"1135850448xxxxx\\",\\"AuthPrincipalType\\":\\"SubUser\\",\\"NoPermissionType\\":\\"ImplicitDeny\\",\\"PolicyType\\":\\"AccountLevelIdentityBasedPolicy\\"}', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'param.illegal', 'errorMessage' => 'Params illegal.', 'description' => ''],
],
[
['errorCode' => 'illegal.auth', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => 'You are not authorized to perform this operation.'],
],
403 => [
['errorCode' => 'No permissions', 'errorMessage' => 'No permissions to access.', 'description' => 'RAM authentication does not have permission'],
],
500 => [
['errorCode' => 'System.error', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request. Please try again.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 0,\\n \\"Message\\": \\"Invalid input parameters\\",\\n \\"Data\\": \\"46434030\\",\\n \\"RequestId\\": \\"C1DA4C6F-963E-5741-AB57-67A554D102FD\\",\\n \\"Success\\": true,\\n \\"AccessDeniedDetail\\": \\"{\\\\\\\\\\\\\\"AuthAction\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ram:ReplyTicket\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalDisplayName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2146216584788xxxxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalOwnerId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1135850448xxxxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"SubUser\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"NoPermissionType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ImplicitDeny\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"PolicyType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"AccountLevelIdentityBasedPolicy\\\\\\\\\\\\\\"}\\"\\n}","type":"json"}]',
'title' => 'ReplyTicket',
'summary' => 'Replies to a ticket. You can call the ListTicketNotes operation to retrieve the reply.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ReplyTicket'],
],
],
'translator' => 'manual',
],
],
'endpoints' => [
['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'workorder.ap-northeast-1.aliyuncs.com', 'endpoint' => 'workorder.ap-northeast-1.aliyuncs.com', 'vpc' => ''],
['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'workorder.ap-southeast-1.aliyuncs.com', 'endpoint' => 'workorder.ap-southeast-1.aliyuncs.com', 'vpc' => ''],
['regionId' => 'ap-southeast-2', 'regionName' => 'Australia (Sydney) Closed', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'workorder.aliyuncs.com', 'endpoint' => 'workorder.aliyuncs.com', 'vpc' => ''],
['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'workorder.aliyuncs.com', 'endpoint' => 'workorder.aliyuncs.com', 'vpc' => ''],
['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'workorder.aliyuncs.com', 'endpoint' => 'workorder.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'workorder.aliyuncs.com', 'endpoint' => 'workorder.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'workorder.aliyuncs.com', 'endpoint' => 'workorder.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'workorder.aliyuncs.com', 'endpoint' => 'workorder.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'workorder.aliyuncs.com', 'endpoint' => 'workorder.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'workorder.aliyuncs.com', 'endpoint' => 'workorder.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'workorder.aliyuncs.com', 'endpoint' => 'workorder.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'workorder.aliyuncs.com', 'endpoint' => 'workorder.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'workorder.aliyuncs.com', 'endpoint' => 'workorder.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'workorder.aliyuncs.com', 'endpoint' => 'workorder.aliyuncs.com', 'vpc' => ''],
['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'workorder.aliyuncs.com', 'endpoint' => 'workorder.aliyuncs.com', 'vpc' => ''],
['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'workorder.aliyuncs.com', 'endpoint' => 'workorder.aliyuncs.com', 'vpc' => ''],
['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'workorder.aliyuncs.com', 'endpoint' => 'workorder.aliyuncs.com', 'vpc' => ''],
['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'workorder.aliyuncs.com', 'endpoint' => 'workorder.aliyuncs.com', 'vpc' => ''],
['regionId' => 'me-east-1', 'regionName' => 'UAE (Dubai)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'workorder.aliyuncs.com', 'endpoint' => 'workorder.aliyuncs.com', 'vpc' => ''],
['regionId' => 'ap-south-1', 'regionName' => 'India (Mumbai) Closed', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'workorder.aliyuncs.com', 'endpoint' => 'workorder.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-shenzhen-finance-1', 'regionName' => 'China South 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'workorder.aliyuncs.com', 'endpoint' => 'workorder.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'workorder.aliyuncs.com', 'endpoint' => 'workorder.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-north-2-gov-1', 'regionName' => 'Beijing Government Cloud', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'workorder.aliyuncs.com', 'endpoint' => 'workorder.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-hangzhou-finance', 'regionName' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'workorder.aliyuncs.com', 'endpoint' => 'workorder.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-beijing-finance-1', 'regionName' => 'China North 2 Finance (Preview)', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'workorder.aliyuncs.com', 'endpoint' => 'workorder.aliyuncs.com', 'vpc' => ''],
],
'errorCodes' => [
['code' => 'business.error', 'message' => 'The business does not allow the current operation.', 'http_code' => 400, 'description' => ''],
['code' => 'illegal.auth', 'message' => 'You are not authorized to perform the operation.', 'http_code' => 401, 'description' => 'You are not authorized to perform this operation.'],
['code' => 'Illegal.NeedAccessChinaSite', 'message' => 'Please visit the China site. The endpoint is workorder.aliyuncs.com.', 'http_code' => 400, 'description' => 'Please visit the china site. endpoint is workorder.aliyuncs.com.'],
['code' => 'Illegal.NeedAccessInternationalSite', 'message' => 'Please visit the international site. The endpoint is workorder.ap-southeast-1.aliyuncs.com.', 'http_code' => 400, 'description' => 'Please visit the international site . endpoint is workorder.ap-southeast-1.aliyuncs.com.'],
['code' => 'illegal.param', 'message' => 'Illegal param.', 'http_code' => 400, 'description' => ''],
['code' => 'illegalParam.emailOrPhone', 'message' => 'The specified contact email or mobile phone number must be the data received by the account messenger.', 'http_code' => 400, 'description' => ''],
['code' => 'No permissions', 'message' => 'No permissions to access.', 'http_code' => 403, 'description' => 'RAM authentication does not have permission'],
['code' => 'NoPermission', 'message' => 'No permissions to access.', 'http_code' => 403, 'description' => 'RAM authentication does not have permission'],
['code' => 'param.illegal', 'message' => 'The specified parameter is invalid. Please check the parameter.', 'http_code' => 401, 'description' => 'The specified parameter is invalid. Please check the parameter.'],
['code' => 'System.error', 'message' => 'An error occurred while processing your request.', 'http_code' => 500, 'description' => 'An error occurred while processing your request. Please try again.'],
['code' => 'Throttling.Api', 'message' => 'The request was denied due to API flow control.', 'http_code' => 429, 'description' => 'The request was denied due to API flow control.'],
],
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateTicket'],
['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListTickets'],
['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListProducts'],
['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ReopenTicket'],
['threshold' => '256', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetTicket'],
['threshold' => '20', 'countWindow' => 60, 'regionId' => '*', 'api' => 'EvaluateTicket'],
['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListCategories'],
['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CloseTicket'],
['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetAttachmentUploadUrl'],
['threshold' => '256', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListTicketNotes'],
['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetMqConsumerTag'],
['threshold' => '20', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ReplyTicket'],
],
],
];
|