/
tag.d.ts
818 lines (742 loc) · 31.2 KB
/
tag.d.ts
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
/// <reference types="node" />
import { AxiosPromise, AxiosRequestConfig } from "axios";
/** 失败资源信息。绑定或解绑资源标签时失败返回 */
declare interface FailedResource {
/** 失败的资源六段式 */
Resource: string;
/** 错误码 */
Code: string;
/** 错误信息 */
Message: string;
}
/** 项目信息 */
declare interface Project {
/** 项目ID */
ProjectId: number;
/** 项目名称 */
ProjectName: string;
/** 创建人uin */
CreatorUin: number;
/** 项目描述 */
ProjectInfo: string;
/** 创建时间 */
CreateTime: string;
}
/** 资源标签键值 */
declare interface ResourceIdTag {
/** 资源唯一标识 */
ResourceId: string | null;
/** 标签键值对 */
TagKeyValues: TagInfo[] | null;
}
/** 资源标签 */
declare interface ResourceTag {
/** 资源所在地域 */
ResourceRegion: string | null;
/** 业务类型 */
ServiceType: string | null;
/** 资源前缀 */
ResourcePrefix: string | null;
/** 资源唯一标记 */
ResourceId: string | null;
/** 资源标签 */
Tags: TagInfo[] | null;
}
/** 资源及关联的标签(键和值)。 */
declare interface ResourceTagMapping {
/** 资源六段式。腾讯云使用资源六段式描述一个资源。例如:ResourceList.1 = qcs::${ServiceType}:${Region}:${Account}:${ResourcePreifx}/${ResourceId}。 */
Resource: string;
/** 资源关联的标签列表 */
Tags: TagInfo[];
}
/** 表示一个标签键值对 */
declare interface TagInfo {
/** 标签键 */
TagKey: string;
/** 标签值 */
TagValue: string;
/** 标签类型。取值: Custom:自定义标签。 System:系统标签。 All:全部标签。 默认值:All。 */
Category?: string | null;
}
/** tag过滤数组多个是与的关系 */
declare interface TagFilter {
/** 标签键 */
TagKey: string;
/** 标签值数组 多个值的话是或的关系 */
TagValue?: string[];
}
/** 标签键对象 */
declare interface TagKeyObject {
/** 标签键 */
TagKey: string;
}
/** 标签键值对以及资源ID */
declare interface TagResource {
/** 标签键 */
TagKey?: string;
/** 标签值 */
TagValue?: string;
/** 资源ID */
ResourceId?: string;
/** 标签键MD5值 */
TagKeyMd5?: string;
/** 标签值MD5值 */
TagValueMd5?: string;
/** 资源类型 */
ServiceType?: string | null;
/** 标签类型。取值: Custom:自定义标签。 System:系统标签。 */
Category?: string | null;
}
/** 表示一个标签键值对以及是否允许删除 */
declare interface TagWithDelete {
/** 标签键 */
TagKey?: string;
/** 标签值 */
TagValue?: string;
/** 是否可以删除 */
CanDelete?: number;
/** 标签类型。取值: Custom:自定义标签。 System:系统标签。 All:全部标签。 默认值:All。 */
Category?: string | null;
}
declare interface AddProjectRequest {
/** 项目名称 */
ProjectName: string;
/** 项目描述 */
Info?: string;
}
declare interface AddProjectResponse {
/** 项目Id */
ProjectId?: number;
/** 是否为新项目,1是新项目,0不是新项目 */
IsNew?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface AddResourceTagRequest {
/** 需要绑定的标签键,取值规范参考:https://cloud.tencent.com/document/product/651/13354 */
TagKey: string;
/** 需要绑定的标签值,取值规范参考:https://cloud.tencent.com/document/product/651/13354 */
TagValue: string;
/** 待关联的资源,用标准的资源六段式表示。正确的资源六段式请参考:https://cloud.tencent.com/document/product/651/89122 */
Resource: string;
}
declare interface AddResourceTagResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface AttachResourcesTagRequest {
/** 业务的英文简称,即资源六段式第三段。资源六段式的描述方式参考:https://cloud.tencent.com/document/product/651/89122 */
ServiceType: string;
/** 资源ID数组,资源个数最多为50 */
ResourceIds: string[];
/** 需要绑定的标签键,取值规范参考:https://cloud.tencent.com/document/product/651/13354 */
TagKey: string;
/** 需要绑定的标签值,取值规范参考:https://cloud.tencent.com/document/product/651/13354 */
TagValue: string;
/** 资源所在地域,不区分地域的资源则不必填。区分地域的资源则必填,且必填时必须是参数ResourceIds.N资源所对应的地域,且如果ResourceIds.N为批量时,这些资源也必须是同一个地域的。例如示例值:ap-beijing,则参数ResourceIds.N中都应该填写该地域的资源。 */
ResourceRegion?: string;
/** 资源前缀(资源六段式中最后一段"/"前面的部分),cos存储桶不需要传入该字段,其他云资源必填 */
ResourcePrefix?: string;
}
declare interface AttachResourcesTagResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateTagRequest {
/** 标签键 */
TagKey: string;
/** 标签值 */
TagValue: string;
}
declare interface CreateTagResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateTagsRequest {
/** 标签列表。N取值范围:0~9 */
Tags?: TagInfo[];
}
declare interface CreateTagsResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteResourceTagRequest {
/** 标签键 */
TagKey: string;
/** [ 资源六段式描述 ](https://cloud.tencent.com/document/product/598/10606) */
Resource: string;
}
declare interface DeleteResourceTagResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteTagRequest {
/** 需要删除的标签键 */
TagKey: string;
/** 需要删除的标签值 */
TagValue: string;
}
declare interface DeleteTagResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteTagsRequest {
/** 标签列表。N取值范围:0~9 */
Tags: TagInfo[];
}
declare interface DeleteTagsResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeProjectsRequest {
/** 传1拉取所有项目(包括隐藏项目),传0拉取显示项目 */
AllList: number;
/** 分页条数,固定值1000。 */
Limit: number;
/** 分页偏移量。 */
Offset: number;
/** 按项目ID筛选,大于0 */
ProjectId?: number;
/** 按项目名称筛选 */
ProjectName?: string;
}
declare interface DescribeProjectsResponse {
/** 数据总条数 */
Total?: number;
/** 项目列表 */
Projects?: Project[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeResourceTagsByResourceIdsRequest {
/** 业务类型 */
ServiceType: string;
/** 资源前缀 */
ResourcePrefix: string;
/** 资源ID数组,大小不超过50 */
ResourceIds: string[];
/** 资源所在地域 */
ResourceRegion: string;
/** 数据偏移量,默认为 0, 必须为Limit参数的整数倍 */
Offset?: number;
/** 每页大小,默认为 15 */
Limit?: number;
/** 标签类型。取值: Custom:自定义标签。 System:系统标签。 All:全部标签。 默认值:All。 */
Category?: string;
}
declare interface DescribeResourceTagsByResourceIdsResponse {
/** 结果总数 */
TotalCount?: number;
/** 数据位移偏量 */
Offset?: number;
/** 每页大小 */
Limit?: number;
/** 标签列表 */
Tags?: TagResource[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeResourceTagsByResourceIdsSeqRequest {
/** 业务类型 */
ServiceType: string;
/** 资源前缀 */
ResourcePrefix: string;
/** 资源唯一标记 */
ResourceIds: string[];
/** 资源所在地域 */
ResourceRegion: string;
/** 数据偏移量,默认为 0, 必须为Limit参数的整数倍 */
Offset?: number;
/** 每页大小,默认为 15 */
Limit?: number;
}
declare interface DescribeResourceTagsByResourceIdsSeqResponse {
/** 结果总数 */
TotalCount?: number;
/** 数据位移偏量 */
Offset?: number;
/** 每页大小 */
Limit?: number;
/** 标签列表 */
Tags?: TagResource[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeResourceTagsByTagKeysRequest {
/** 业务类型 */
ServiceType: string;
/** 资源前缀 */
ResourcePrefix: string;
/** 资源地域 */
ResourceRegion: string;
/** 资源唯一标识ID的列表,列表容量不超过20 */
ResourceIds: string[];
/** 资源标签键列表,列表容量不超过20 */
TagKeys: string[];
/** 每页大小,默认为 400 */
Limit?: number;
/** 数据偏移量,默认为 0, 必须为Limit参数的整数倍 */
Offset?: number;
}
declare interface DescribeResourceTagsByTagKeysResponse {
/** 结果总数 */
TotalCount?: number;
/** 数据位移偏量 */
Offset?: number;
/** 每页大小 */
Limit?: number;
/** 资源标签 */
Rows?: ResourceIdTag[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeResourceTagsRequest {
/** 创建者uin */
CreateUin?: number;
/** 资源所在地域 */
ResourceRegion?: string;
/** 业务类型 */
ServiceType?: string;
/** 资源前缀 */
ResourcePrefix?: string;
/** 资源唯一标识。只输入ResourceId进行查询可能会查询较慢,或者无法匹配到结果,建议在输入ResourceId的同时也输入ServiceType、ResourcePrefix和ResourceRegion(不区分地域的资源可忽略该参数) */
ResourceId?: string;
/** 数据偏移量,默认为 0, 必须为Limit参数的整数倍 */
Offset?: number;
/** 每页大小,默认为 15 */
Limit?: number;
/** 是否是cos的资源(0或者1),输入的ResourceId为cos资源时必填 */
CosResourceId?: number;
}
declare interface DescribeResourceTagsResponse {
/** 结果总数 */
TotalCount?: number;
/** 数据位移偏量 */
Offset?: number;
/** 每页大小 */
Limit?: number | null;
/** 资源标签 */
Rows?: TagResource[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeResourcesByTagsRequest {
/** 标签过滤数组 */
TagFilters: TagFilter[];
/** 创建标签者uin */
CreateUin?: number;
/** 数据偏移量,默认为 0, 必须为Limit参数的整数倍 */
Offset?: number;
/** 每页大小,默认为 15 */
Limit?: number;
/** 资源前缀 */
ResourcePrefix?: string;
/** 资源唯一标记 */
ResourceId?: string;
/** 资源所在地域 */
ResourceRegion?: string;
/** 业务类型 */
ServiceType?: string;
}
declare interface DescribeResourcesByTagsResponse {
/** 结果总数 */
TotalCount: number;
/** 数据位移偏量 */
Offset: number;
/** 每页大小 */
Limit: number | null;
/** 资源标签 */
Rows: ResourceTag[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeResourcesByTagsUnionRequest {
/** 标签过滤数组 */
TagFilters: TagFilter[];
/** 创建标签者uin */
CreateUin?: number;
/** 数据偏移量,默认为 0, 必须为Limit参数的整数倍 */
Offset?: number;
/** 每页大小,默认为 15 */
Limit?: number;
/** 资源前缀 */
ResourcePrefix?: string;
/** 资源唯一标记 */
ResourceId?: string;
/** 资源所在地域 */
ResourceRegion?: string;
/** 业务类型 */
ServiceType?: string;
}
declare interface DescribeResourcesByTagsUnionResponse {
/** 结果总数 */
TotalCount?: number;
/** 数据位移偏量 */
Offset?: number;
/** 每页大小 */
Limit?: number;
/** 资源标签 */
Rows?: ResourceTag[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeTagKeysRequest {
/** 创建者用户 Uin,不传或为空只将 Uin 作为条件查询 */
CreateUin?: number;
/** 数据偏移量,默认为 0, 必须为Limit参数的整数倍 */
Offset?: number;
/** 每页大小,默认为 15,最大1000 */
Limit?: number;
/** 是否展现项目 */
ShowProject?: number;
/** 标签类型。取值: Custom:自定义标签。 System:系统标签。 All:全部标签。 默认值:All。 */
Category?: string;
}
declare interface DescribeTagKeysResponse {
/** 结果总数 */
TotalCount?: number;
/** 数据位移偏量 */
Offset?: number;
/** 每页大小 */
Limit?: number;
/** 标签列表 */
Tags?: string[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeTagValuesRequest {
/** 标签键列表 */
TagKeys: string[];
/** 创建者用户 Uin,不传或为空只将 Uin 作为条件查询 */
CreateUin?: number;
/** 数据偏移量,默认为 0, 必须为Limit参数的整数倍 */
Offset?: number;
/** 每页大小,默认为 15 */
Limit?: number;
/** 标签类型。取值: Custom:自定义标签。 System:系统标签。 All:全部标签。 默认值:All。 */
Category?: string;
}
declare interface DescribeTagValuesResponse {
/** 结果总数 */
TotalCount?: number;
/** 数据位移偏量 */
Offset?: number;
/** 每页大小 */
Limit?: number;
/** 标签列表 */
Tags?: TagInfo[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeTagValuesSeqRequest {
/** 标签键列表 */
TagKeys: string[];
/** 创建者用户 Uin,不传或为空只将 Uin 作为条件查询 */
CreateUin?: number;
/** 数据偏移量,默认为 0, 必须为Limit参数的整数倍 */
Offset?: number;
/** 每页大小,默认为 15 */
Limit?: number;
}
declare interface DescribeTagValuesSeqResponse {
/** 结果总数 */
TotalCount?: number;
/** 数据位移偏量 */
Offset?: number;
/** 每页大小 */
Limit?: number;
/** 标签列表 */
Tags?: TagInfo[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeTagsRequest {
/** 标签键,与标签值同时存在或同时不存在,不存在时表示查询该用户所有标签 */
TagKey?: string;
/** 标签值,与标签键同时存在或同时不存在,不存在时表示查询该用户所有标签 */
TagValue?: string;
/** 数据偏移量,默认为 0, 必须为Limit参数的整数倍 */
Offset?: number;
/** 每页大小,默认为 15 */
Limit?: number;
/** 创建者用户 Uin,不传或为空只将 Uin 作为条件查询 */
CreateUin?: number;
/** 标签键数组,与标签值同时存在或同时不存在,不存在时表示查询该用户所有标签,当与TagKey同时传递时只取本值 */
TagKeys?: string[];
/** 是否展现项目标签 */
ShowProject?: number;
}
declare interface DescribeTagsResponse {
/** 结果总数 */
TotalCount?: number;
/** 数据位移偏量 */
Offset?: number;
/** 每页大小 */
Limit?: number;
/** 标签列表 */
Tags?: TagWithDelete[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeTagsSeqRequest {
/** 标签键,与标签值同时存在或同时不存在,不存在时表示查询该用户所有标签 */
TagKey?: string;
/** 标签值,与标签键同时存在或同时不存在,不存在时表示查询该用户所有标签 */
TagValue?: string;
/** 数据偏移量,默认为 0, 必须为Limit参数的整数倍 */
Offset?: number;
/** 每页大小,默认为 15 */
Limit?: number;
/** 创建者用户 Uin,不传或为空只将 Uin 作为条件查询 */
CreateUin?: number;
/** 标签键数组,与标签值同时存在或同时不存在,不存在时表示查询该用户所有标签,当与TagKey同时传递时只取本值 */
TagKeys?: string[];
/** 是否展现项目标签 */
ShowProject?: number;
}
declare interface DescribeTagsSeqResponse {
/** 结果总数 */
TotalCount?: number;
/** 数据位移偏量 */
Offset?: number;
/** 每页大小 */
Limit?: number;
/** 标签列表 */
Tags?: TagWithDelete[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DetachResourcesTagRequest {
/** 资源所属业务名称(资源六段式中的第三段) */
ServiceType: string;
/** 资源ID数组,资源个数最多为50 */
ResourceIds: string[];
/** 需要解绑的标签键 */
TagKey: string;
/** 资源所在地域,不区分地域的资源不需要传入该字段,区分地域的资源必填 */
ResourceRegion?: string;
/** 资源前缀(资源六段式中最后一段"/"前面的部分),cos存储桶不需要传入该字段,其他云资源必填 */
ResourcePrefix?: string;
}
declare interface DetachResourcesTagResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface GetResourcesRequest {
/** 资源六段式列表。腾讯云使用资源六段式描述一个资源。例如:ResourceList.1 = qcs::${ServiceType}:${Region}:${Account}:${ResourcePreifx}/${ResourceId}。如果传入了此参数会返回所有匹配的资源列表,指定的MaxResults会失效。N取值范围:0~9 */
ResourceList?: string[];
/** 标签键和标签值。指定多个标签,会查询同时绑定了该多个标签的资源。N取值范围:0~5。每个TagFilters中的TagValue最多支持10个 */
TagFilters?: TagFilter[];
/** 从上一页的响应中获取的下一页的Token值。如果是第一次请求,设置为空。 */
PaginationToken?: string;
/** 每一页返回的数据最大条数,最大200。缺省值:50。 */
MaxResults?: number;
}
declare interface GetResourcesResponse {
/** 获取的下一页的Token值 */
PaginationToken: string;
/** 资源及关联的标签(键和值)列表 */
ResourceTagMappingList: ResourceTagMapping[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface GetTagKeysRequest {
/** 从上一页的响应中获取的下一页的Token值。如果是第一次请求,设置为空。 */
PaginationToken?: string;
/** 每一页返回的数据最大条数,最大1000。缺省值:50。 */
MaxResults?: number;
/** 标签类型。取值: Custom:自定义标签。 System:系统标签。 All:全部标签。 默认值:All。 */
Category?: string;
}
declare interface GetTagKeysResponse {
/** 获取的下一页的Token值,如果当前是最后一页,返回为空 */
PaginationToken?: string;
/** 标签键信息。 */
TagKeys?: string[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface GetTagValuesRequest {
/** 标签键。返回所有标签键列表对应的标签值。最大长度:20 */
TagKeys: string[];
/** 从上一页的响应中获取的下一页的Token值。如果是第一次请求,设置为空。 */
PaginationToken?: string;
/** 每一页返回的数据最大条数,最大1000。缺省值:50。 */
MaxResults?: number;
/** 标签类型。取值: Custom:自定义标签。 System:系统标签。 All:全部标签。 默认值:All。 */
Category?: string;
}
declare interface GetTagValuesResponse {
/** 获取的下一页的Token值,如果当前是最后一页,返回为空 */
PaginationToken?: string;
/** 标签列表。 */
Tags?: TagInfo[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface GetTagsRequest {
/** 从上一页的响应中获取的下一页的Token值。如果是第一次请求,设置为空。 */
PaginationToken?: string;
/** 每一页返回的数据最大条数,最大1000。缺省值:50。 */
MaxResults?: number;
/** 标签键。返回所有标签键列表对应的标签。最大长度:20 */
TagKeys?: string[];
/** 标签类型。取值: Custom:自定义标签。 System:系统标签。 All:全部标签。 默认值:All。 */
Category?: string;
}
declare interface GetTagsResponse {
/** 获取的下一页的Token值,如果当前是最后一页,返回为空 */
PaginationToken?: string;
/** 标签列表。 */
Tags?: TagInfo[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ModifyResourceTagsRequest {
/** [ 资源六段式描述 ](https://cloud.tencent.com/document/product/598/10606) */
Resource: string;
/** 需要增加或修改的标签集合。如果Resource描述的资源未关联输入的标签键,则增加关联;若已关联,则将该资源关联的键对应的标签值修改为输入值。本接口中ReplaceTags和DeleteTags二者必须存在其一,且二者不能包含相同的标签键。可以不传该参数,但不能是空数组。 */
ReplaceTags?: TagInfo[];
/** 需要解关联的标签集合。本接口中ReplaceTags和DeleteTags二者必须存在其一,且二者不能包含相同的标签键。可以不传该参数,但不能是空数组。 */
DeleteTags?: TagKeyObject[];
}
declare interface ModifyResourceTagsResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ModifyResourcesTagValueRequest {
/** 资源所属业务名称(资源六段式中的第三段) */
ServiceType: string;
/** 资源ID数组,资源个数最多为50 */
ResourceIds: string[];
/** 标签键 */
TagKey: string;
/** 标签值 */
TagValue: string;
/** 资源所在地域,不区分地域的资源不需要传入该字段,区分地域的资源必填 */
ResourceRegion?: string;
/** 资源前缀(资源六段式中最后一段"/"前面的部分),cos存储桶不需要传入该字段,其他云资源必填 */
ResourcePrefix?: string;
}
declare interface ModifyResourcesTagValueResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface TagResourcesRequest {
/** 待绑定的云资源,用标准的资源六段式表示。正确的资源六段式请参考:[标准的资源六段式](https://cloud.tencent.com/document/product/598/10606)和[支持标签的云产品及资源描述方式](https://cloud.tencent.com/document/product/651/89122)。N取值范围:0~9 */
ResourceList: string[];
/** 标签键和标签值。如果指定多个标签,则会为指定资源同时创建并绑定该多个标签。同一个资源上的同一个标签键只能对应一个标签值。如果您尝试添加已有标签键,则对应的标签值会更新为新值。如果标签不存在会为您自动创建标签。N取值范围:0~9 */
Tags: TagInfo[];
}
declare interface TagResourcesResponse {
/** 失败资源信息。创建并绑定标签成功时,返回的FailedResources为空。创建并绑定标签失败或部分失败时,返回的FailedResources会显示失败资源的详细信息。 */
FailedResources?: FailedResource[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface UnTagResourcesRequest {
/** 资源六段式列表。腾讯云使用资源六段式描述一个资源。可参考[访问管理](https://cloud.tencent.com/document/product/598/67350)-概览-接口列表-资源六段式信息例如:ResourceList.1 = qcs::${ServiceType}:${Region}:uin/${Account}:${ResourcePrefix}/${ResourceId}。N取值范围:0~9 */
ResourceList: string[];
/** 标签键。取值范围:0~9 */
TagKeys: string[];
}
declare interface UnTagResourcesResponse {
/** 失败资源信息。解绑标签成功时,返回的FailedResources为空。解绑标签失败或部分失败时,返回的FailedResources会显示失败资源的详细信息。 */
FailedResources?: FailedResource[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface UpdateProjectRequest {
/** 项目ID */
ProjectId: number;
/** 项目名称 */
ProjectName?: string;
/** 禁用项目,1,禁用,0,启用 */
Disable?: number;
/** 备注 */
Info?: string;
}
declare interface UpdateProjectResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface UpdateResourceTagValueRequest {
/** 资源关联的标签键 */
TagKey: string;
/** 修改后的标签值 */
TagValue: string;
/** [ 资源六段式描述 ](https://cloud.tencent.com/document/product/598/10606) */
Resource: string;
}
declare interface UpdateResourceTagValueResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
/** {@link Tag 标签} */
declare interface Tag {
(): Versions;
/** 创建项目 {@link AddProjectRequest} {@link AddProjectResponse} */
AddProject(data: AddProjectRequest, config?: AxiosRequestConfig): AxiosPromise<AddProjectResponse>;
/** 标签关联资源 {@link AddResourceTagRequest} {@link AddResourceTagResponse} */
AddResourceTag(data: AddResourceTagRequest, config?: AxiosRequestConfig): AxiosPromise<AddResourceTagResponse>;
/** 标签关联批量资源 {@link AttachResourcesTagRequest} {@link AttachResourcesTagResponse} */
AttachResourcesTag(data: AttachResourcesTagRequest, config?: AxiosRequestConfig): AxiosPromise<AttachResourcesTagResponse>;
/** 创建标签 {@link CreateTagRequest} {@link CreateTagResponse} */
CreateTag(data: CreateTagRequest, config?: AxiosRequestConfig): AxiosPromise<CreateTagResponse>;
/** 批量创建标签 {@link CreateTagsRequest} {@link CreateTagsResponse} */
CreateTags(data?: CreateTagsRequest, config?: AxiosRequestConfig): AxiosPromise<CreateTagsResponse>;
/** 标签解绑资源 {@link DeleteResourceTagRequest} {@link DeleteResourceTagResponse} */
DeleteResourceTag(data: DeleteResourceTagRequest, config?: AxiosRequestConfig): AxiosPromise<DeleteResourceTagResponse>;
/** 删除标签 {@link DeleteTagRequest} {@link DeleteTagResponse} */
DeleteTag(data: DeleteTagRequest, config?: AxiosRequestConfig): AxiosPromise<DeleteTagResponse>;
/** 批量删除标签 {@link DeleteTagsRequest} {@link DeleteTagsResponse} */
DeleteTags(data: DeleteTagsRequest, config?: AxiosRequestConfig): AxiosPromise<DeleteTagsResponse>;
/** 获取项目列表 {@link DescribeProjectsRequest} {@link DescribeProjectsResponse} */
DescribeProjects(data: DescribeProjectsRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeProjectsResponse>;
/** 查询资源关联标签 {@link DescribeResourceTagsRequest} {@link DescribeResourceTagsResponse} */
DescribeResourceTags(data?: DescribeResourceTagsRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeResourceTagsResponse>;
/** 批量查看资源关联的标签 {@link DescribeResourceTagsByResourceIdsRequest} {@link DescribeResourceTagsByResourceIdsResponse} */
DescribeResourceTagsByResourceIds(data: DescribeResourceTagsByResourceIdsRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeResourceTagsByResourceIdsResponse>;
/** 按顺序查看资源关联的标签 {@link DescribeResourceTagsByResourceIdsSeqRequest} {@link DescribeResourceTagsByResourceIdsSeqResponse} */
DescribeResourceTagsByResourceIdsSeq(data: DescribeResourceTagsByResourceIdsSeqRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeResourceTagsByResourceIdsSeqResponse>;
/** 根据标签键获取资源标签 {@link DescribeResourceTagsByTagKeysRequest} {@link DescribeResourceTagsByTagKeysResponse} */
DescribeResourceTagsByTagKeys(data: DescribeResourceTagsByTagKeysRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeResourceTagsByTagKeysResponse>;
/** 通过标签查询资源列表 {@link DescribeResourcesByTagsRequest} {@link DescribeResourcesByTagsResponse} */
DescribeResourcesByTags(data: DescribeResourcesByTagsRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeResourcesByTagsResponse>;
/** 通过标签查询资源列表并集 {@link DescribeResourcesByTagsUnionRequest} {@link DescribeResourcesByTagsUnionResponse} */
DescribeResourcesByTagsUnion(data: DescribeResourcesByTagsUnionRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeResourcesByTagsUnionResponse>;
/** 查询标签键 {@link DescribeTagKeysRequest} {@link DescribeTagKeysResponse} */
DescribeTagKeys(data?: DescribeTagKeysRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeTagKeysResponse>;
/** 查询标签值 {@link DescribeTagValuesRequest} {@link DescribeTagValuesResponse} */
DescribeTagValues(data: DescribeTagValuesRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeTagValuesResponse>;
/** 按顺序查询标签值 {@link DescribeTagValuesSeqRequest} {@link DescribeTagValuesSeqResponse} */
DescribeTagValuesSeq(data: DescribeTagValuesSeqRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeTagValuesSeqResponse>;
/** 查询标签列表 {@link DescribeTagsRequest} {@link DescribeTagsResponse} */
DescribeTags(data?: DescribeTagsRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeTagsResponse>;
/** 按顺序查询标签列表 {@link DescribeTagsSeqRequest} {@link DescribeTagsSeqResponse} */
DescribeTagsSeq(data?: DescribeTagsSeqRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeTagsSeqResponse>;
/** 标签解绑批量资源 {@link DetachResourcesTagRequest} {@link DetachResourcesTagResponse} */
DetachResourcesTag(data: DetachResourcesTagRequest, config?: AxiosRequestConfig): AxiosPromise<DetachResourcesTagResponse>;
/** 查询资源标签列表 {@link GetResourcesRequest} {@link GetResourcesResponse} */
GetResources(data?: GetResourcesRequest, config?: AxiosRequestConfig): AxiosPromise<GetResourcesResponse>;
/** 查询标签键列表 {@link GetTagKeysRequest} {@link GetTagKeysResponse} */
GetTagKeys(data?: GetTagKeysRequest, config?: AxiosRequestConfig): AxiosPromise<GetTagKeysResponse>;
/** 查询标签值列表 {@link GetTagValuesRequest} {@link GetTagValuesResponse} */
GetTagValues(data: GetTagValuesRequest, config?: AxiosRequestConfig): AxiosPromise<GetTagValuesResponse>;
/** 获取标签列表 {@link GetTagsRequest} {@link GetTagsResponse} */
GetTags(data?: GetTagsRequest, config?: AxiosRequestConfig): AxiosPromise<GetTagsResponse>;
/** 批量修改资源关联的标签 {@link ModifyResourceTagsRequest} {@link ModifyResourceTagsResponse} */
ModifyResourceTags(data: ModifyResourceTagsRequest, config?: AxiosRequestConfig): AxiosPromise<ModifyResourceTagsResponse>;
/** 修改批量资源关联的标签值 {@link ModifyResourcesTagValueRequest} {@link ModifyResourcesTagValueResponse} */
ModifyResourcesTagValue(data: ModifyResourcesTagValueRequest, config?: AxiosRequestConfig): AxiosPromise<ModifyResourcesTagValueResponse>;
/** 为资源绑定标签 {@link TagResourcesRequest} {@link TagResourcesResponse} */
TagResources(data: TagResourcesRequest, config?: AxiosRequestConfig): AxiosPromise<TagResourcesResponse>;
/** 为资源解绑标签 {@link UnTagResourcesRequest} {@link UnTagResourcesResponse} */
UnTagResources(data: UnTagResourcesRequest, config?: AxiosRequestConfig): AxiosPromise<UnTagResourcesResponse>;
/** 修改项目 {@link UpdateProjectRequest} {@link UpdateProjectResponse} */
UpdateProject(data: UpdateProjectRequest, config?: AxiosRequestConfig): AxiosPromise<UpdateProjectResponse>;
/** 修改资源标签值 {@link UpdateResourceTagValueRequest} {@link UpdateResourceTagValueResponse} */
UpdateResourceTagValue(data: UpdateResourceTagValueRequest, config?: AxiosRequestConfig): AxiosPromise<UpdateResourceTagValueResponse>;
}
export declare type Versions = ["2018-08-13"];
export default Tag;