@alicloud/cms20190101 2.0.7 → 2.0.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/client.d.ts +456 -104
- package/dist/client.js +603 -104
- package/dist/client.js.map +1 -1
- package/package.json +1 -1
- package/src/client.ts +727 -106
package/dist/client.d.ts
CHANGED
|
@@ -141,6 +141,25 @@ export declare class MetricStat extends $tea.Model {
|
|
|
141
141
|
[key: string]: any;
|
|
142
142
|
});
|
|
143
143
|
}
|
|
144
|
+
export declare class MigrationJob extends $tea.Model {
|
|
145
|
+
createTime?: string;
|
|
146
|
+
detail?: string;
|
|
147
|
+
jobStatus?: string;
|
|
148
|
+
plan?: MigrationJobPlan;
|
|
149
|
+
ruleNames?: string[];
|
|
150
|
+
source?: MigrationJobSource[];
|
|
151
|
+
updateTime?: string;
|
|
152
|
+
uuid?: string;
|
|
153
|
+
static names(): {
|
|
154
|
+
[key: string]: string;
|
|
155
|
+
};
|
|
156
|
+
static types(): {
|
|
157
|
+
[key: string]: any;
|
|
158
|
+
};
|
|
159
|
+
constructor(map?: {
|
|
160
|
+
[key: string]: any;
|
|
161
|
+
});
|
|
162
|
+
}
|
|
144
163
|
export declare class NotificationStrategy extends $tea.Model {
|
|
145
164
|
createTime?: string;
|
|
146
165
|
description?: string;
|
|
@@ -3474,6 +3493,7 @@ export declare class DescribeEventRuleAttributeResponse extends $tea.Model {
|
|
|
3474
3493
|
}
|
|
3475
3494
|
export declare class DescribeEventRuleListRequest extends $tea.Model {
|
|
3476
3495
|
groupId?: string;
|
|
3496
|
+
isEnable?: boolean;
|
|
3477
3497
|
namePrefix?: string;
|
|
3478
3498
|
pageNumber?: string;
|
|
3479
3499
|
pageSize?: string;
|
|
@@ -8313,6 +8333,286 @@ export declare class EscalationRuleEscalations extends $tea.Model {
|
|
|
8313
8333
|
[key: string]: any;
|
|
8314
8334
|
});
|
|
8315
8335
|
}
|
|
8336
|
+
export declare class MigrationJobPlanContactsChannels extends $tea.Model {
|
|
8337
|
+
level?: number;
|
|
8338
|
+
type?: string;
|
|
8339
|
+
value?: string;
|
|
8340
|
+
static names(): {
|
|
8341
|
+
[key: string]: string;
|
|
8342
|
+
};
|
|
8343
|
+
static types(): {
|
|
8344
|
+
[key: string]: any;
|
|
8345
|
+
};
|
|
8346
|
+
constructor(map?: {
|
|
8347
|
+
[key: string]: any;
|
|
8348
|
+
});
|
|
8349
|
+
}
|
|
8350
|
+
export declare class MigrationJobPlanContacts extends $tea.Model {
|
|
8351
|
+
channels?: MigrationJobPlanContactsChannels[];
|
|
8352
|
+
name?: string;
|
|
8353
|
+
static names(): {
|
|
8354
|
+
[key: string]: string;
|
|
8355
|
+
};
|
|
8356
|
+
static types(): {
|
|
8357
|
+
[key: string]: any;
|
|
8358
|
+
};
|
|
8359
|
+
constructor(map?: {
|
|
8360
|
+
[key: string]: any;
|
|
8361
|
+
});
|
|
8362
|
+
}
|
|
8363
|
+
export declare class MigrationJobPlanEscalationsEscalationsLevelGroups extends $tea.Model {
|
|
8364
|
+
critical?: string[];
|
|
8365
|
+
info?: string[];
|
|
8366
|
+
resolved?: string[];
|
|
8367
|
+
warning?: string[];
|
|
8368
|
+
static names(): {
|
|
8369
|
+
[key: string]: string;
|
|
8370
|
+
};
|
|
8371
|
+
static types(): {
|
|
8372
|
+
[key: string]: any;
|
|
8373
|
+
};
|
|
8374
|
+
constructor(map?: {
|
|
8375
|
+
[key: string]: any;
|
|
8376
|
+
});
|
|
8377
|
+
}
|
|
8378
|
+
export declare class MigrationJobPlanEscalationsEscalations extends $tea.Model {
|
|
8379
|
+
groups?: string[];
|
|
8380
|
+
levelGroups?: MigrationJobPlanEscalationsEscalationsLevelGroups;
|
|
8381
|
+
static names(): {
|
|
8382
|
+
[key: string]: string;
|
|
8383
|
+
};
|
|
8384
|
+
static types(): {
|
|
8385
|
+
[key: string]: any;
|
|
8386
|
+
};
|
|
8387
|
+
constructor(map?: {
|
|
8388
|
+
[key: string]: any;
|
|
8389
|
+
});
|
|
8390
|
+
}
|
|
8391
|
+
export declare class MigrationJobPlanEscalations extends $tea.Model {
|
|
8392
|
+
escalations?: MigrationJobPlanEscalationsEscalations[];
|
|
8393
|
+
name?: string;
|
|
8394
|
+
uuid?: string;
|
|
8395
|
+
static names(): {
|
|
8396
|
+
[key: string]: string;
|
|
8397
|
+
};
|
|
8398
|
+
static types(): {
|
|
8399
|
+
[key: string]: any;
|
|
8400
|
+
};
|
|
8401
|
+
constructor(map?: {
|
|
8402
|
+
[key: string]: any;
|
|
8403
|
+
});
|
|
8404
|
+
}
|
|
8405
|
+
export declare class MigrationJobPlanGroups extends $tea.Model {
|
|
8406
|
+
contacts?: string[];
|
|
8407
|
+
name?: string;
|
|
8408
|
+
static names(): {
|
|
8409
|
+
[key: string]: string;
|
|
8410
|
+
};
|
|
8411
|
+
static types(): {
|
|
8412
|
+
[key: string]: any;
|
|
8413
|
+
};
|
|
8414
|
+
constructor(map?: {
|
|
8415
|
+
[key: string]: any;
|
|
8416
|
+
});
|
|
8417
|
+
}
|
|
8418
|
+
export declare class MigrationJobPlanStrategiesEscalationSetting extends $tea.Model {
|
|
8419
|
+
escalationUuid?: string;
|
|
8420
|
+
static names(): {
|
|
8421
|
+
[key: string]: string;
|
|
8422
|
+
};
|
|
8423
|
+
static types(): {
|
|
8424
|
+
[key: string]: any;
|
|
8425
|
+
};
|
|
8426
|
+
constructor(map?: {
|
|
8427
|
+
[key: string]: any;
|
|
8428
|
+
});
|
|
8429
|
+
}
|
|
8430
|
+
export declare class MigrationJobPlanStrategiesPushingSetting extends $tea.Model {
|
|
8431
|
+
targetUuids?: string[];
|
|
8432
|
+
static names(): {
|
|
8433
|
+
[key: string]: string;
|
|
8434
|
+
};
|
|
8435
|
+
static types(): {
|
|
8436
|
+
[key: string]: any;
|
|
8437
|
+
};
|
|
8438
|
+
constructor(map?: {
|
|
8439
|
+
[key: string]: any;
|
|
8440
|
+
});
|
|
8441
|
+
}
|
|
8442
|
+
export declare class MigrationJobPlanStrategies extends $tea.Model {
|
|
8443
|
+
escalationSetting?: MigrationJobPlanStrategiesEscalationSetting;
|
|
8444
|
+
name?: string;
|
|
8445
|
+
pushingSetting?: MigrationJobPlanStrategiesPushingSetting;
|
|
8446
|
+
static names(): {
|
|
8447
|
+
[key: string]: string;
|
|
8448
|
+
};
|
|
8449
|
+
static types(): {
|
|
8450
|
+
[key: string]: any;
|
|
8451
|
+
};
|
|
8452
|
+
constructor(map?: {
|
|
8453
|
+
[key: string]: any;
|
|
8454
|
+
});
|
|
8455
|
+
}
|
|
8456
|
+
export declare class MigrationJobPlanSubscriptionsConditions extends $tea.Model {
|
|
8457
|
+
field?: string;
|
|
8458
|
+
op?: string;
|
|
8459
|
+
value?: string;
|
|
8460
|
+
static names(): {
|
|
8461
|
+
[key: string]: string;
|
|
8462
|
+
};
|
|
8463
|
+
static types(): {
|
|
8464
|
+
[key: string]: any;
|
|
8465
|
+
};
|
|
8466
|
+
constructor(map?: {
|
|
8467
|
+
[key: string]: any;
|
|
8468
|
+
});
|
|
8469
|
+
}
|
|
8470
|
+
export declare class MigrationJobPlanSubscriptions extends $tea.Model {
|
|
8471
|
+
conditions?: MigrationJobPlanSubscriptionsConditions[];
|
|
8472
|
+
name?: string;
|
|
8473
|
+
strategyUuid?: string;
|
|
8474
|
+
static names(): {
|
|
8475
|
+
[key: string]: string;
|
|
8476
|
+
};
|
|
8477
|
+
static types(): {
|
|
8478
|
+
[key: string]: any;
|
|
8479
|
+
};
|
|
8480
|
+
constructor(map?: {
|
|
8481
|
+
[key: string]: any;
|
|
8482
|
+
});
|
|
8483
|
+
}
|
|
8484
|
+
export declare class MigrationJobPlanTargetsHttpRequestTarget extends $tea.Model {
|
|
8485
|
+
contentType?: string;
|
|
8486
|
+
method?: string;
|
|
8487
|
+
url?: string;
|
|
8488
|
+
static names(): {
|
|
8489
|
+
[key: string]: string;
|
|
8490
|
+
};
|
|
8491
|
+
static types(): {
|
|
8492
|
+
[key: string]: any;
|
|
8493
|
+
};
|
|
8494
|
+
constructor(map?: {
|
|
8495
|
+
[key: string]: any;
|
|
8496
|
+
});
|
|
8497
|
+
}
|
|
8498
|
+
export declare class MigrationJobPlanTargets extends $tea.Model {
|
|
8499
|
+
arn?: string;
|
|
8500
|
+
httpRequestTarget?: MigrationJobPlanTargetsHttpRequestTarget;
|
|
8501
|
+
name?: string;
|
|
8502
|
+
type?: string;
|
|
8503
|
+
uuid?: string;
|
|
8504
|
+
static names(): {
|
|
8505
|
+
[key: string]: string;
|
|
8506
|
+
};
|
|
8507
|
+
static types(): {
|
|
8508
|
+
[key: string]: any;
|
|
8509
|
+
};
|
|
8510
|
+
constructor(map?: {
|
|
8511
|
+
[key: string]: any;
|
|
8512
|
+
});
|
|
8513
|
+
}
|
|
8514
|
+
export declare class MigrationJobPlan extends $tea.Model {
|
|
8515
|
+
contacts?: MigrationJobPlanContacts[];
|
|
8516
|
+
escalations?: MigrationJobPlanEscalations[];
|
|
8517
|
+
groups?: MigrationJobPlanGroups[];
|
|
8518
|
+
ruleNames?: string[];
|
|
8519
|
+
strategies?: MigrationJobPlanStrategies[];
|
|
8520
|
+
subscriptions?: MigrationJobPlanSubscriptions[];
|
|
8521
|
+
targets?: MigrationJobPlanTargets[];
|
|
8522
|
+
static names(): {
|
|
8523
|
+
[key: string]: string;
|
|
8524
|
+
};
|
|
8525
|
+
static types(): {
|
|
8526
|
+
[key: string]: any;
|
|
8527
|
+
};
|
|
8528
|
+
constructor(map?: {
|
|
8529
|
+
[key: string]: any;
|
|
8530
|
+
});
|
|
8531
|
+
}
|
|
8532
|
+
export declare class MigrationJobSourceRuleKeywordFilter extends $tea.Model {
|
|
8533
|
+
keywords?: string[];
|
|
8534
|
+
relation?: string;
|
|
8535
|
+
static names(): {
|
|
8536
|
+
[key: string]: string;
|
|
8537
|
+
};
|
|
8538
|
+
static types(): {
|
|
8539
|
+
[key: string]: any;
|
|
8540
|
+
};
|
|
8541
|
+
constructor(map?: {
|
|
8542
|
+
[key: string]: any;
|
|
8543
|
+
});
|
|
8544
|
+
}
|
|
8545
|
+
export declare class MigrationJobSourceRulePrimaryFilters extends $tea.Model {
|
|
8546
|
+
field?: string;
|
|
8547
|
+
opType?: string;
|
|
8548
|
+
value?: string;
|
|
8549
|
+
static names(): {
|
|
8550
|
+
[key: string]: string;
|
|
8551
|
+
};
|
|
8552
|
+
static types(): {
|
|
8553
|
+
[key: string]: any;
|
|
8554
|
+
};
|
|
8555
|
+
constructor(map?: {
|
|
8556
|
+
[key: string]: any;
|
|
8557
|
+
});
|
|
8558
|
+
}
|
|
8559
|
+
export declare class MigrationJobSourceRule extends $tea.Model {
|
|
8560
|
+
keywordFilter?: MigrationJobSourceRuleKeywordFilter;
|
|
8561
|
+
name?: string;
|
|
8562
|
+
primaryFilters?: MigrationJobSourceRulePrimaryFilters[];
|
|
8563
|
+
static names(): {
|
|
8564
|
+
[key: string]: string;
|
|
8565
|
+
};
|
|
8566
|
+
static types(): {
|
|
8567
|
+
[key: string]: any;
|
|
8568
|
+
};
|
|
8569
|
+
constructor(map?: {
|
|
8570
|
+
[key: string]: any;
|
|
8571
|
+
});
|
|
8572
|
+
}
|
|
8573
|
+
export declare class MigrationJobSourceTargetsContent extends $tea.Model {
|
|
8574
|
+
group?: string;
|
|
8575
|
+
level?: string;
|
|
8576
|
+
method?: string;
|
|
8577
|
+
region?: string;
|
|
8578
|
+
resourcePath?: string;
|
|
8579
|
+
url?: string;
|
|
8580
|
+
static names(): {
|
|
8581
|
+
[key: string]: string;
|
|
8582
|
+
};
|
|
8583
|
+
static types(): {
|
|
8584
|
+
[key: string]: any;
|
|
8585
|
+
};
|
|
8586
|
+
constructor(map?: {
|
|
8587
|
+
[key: string]: any;
|
|
8588
|
+
});
|
|
8589
|
+
}
|
|
8590
|
+
export declare class MigrationJobSourceTargets extends $tea.Model {
|
|
8591
|
+
content?: MigrationJobSourceTargetsContent;
|
|
8592
|
+
type?: string;
|
|
8593
|
+
static names(): {
|
|
8594
|
+
[key: string]: string;
|
|
8595
|
+
};
|
|
8596
|
+
static types(): {
|
|
8597
|
+
[key: string]: any;
|
|
8598
|
+
};
|
|
8599
|
+
constructor(map?: {
|
|
8600
|
+
[key: string]: any;
|
|
8601
|
+
});
|
|
8602
|
+
}
|
|
8603
|
+
export declare class MigrationJobSource extends $tea.Model {
|
|
8604
|
+
rule?: MigrationJobSourceRule;
|
|
8605
|
+
targets?: MigrationJobSourceTargets[];
|
|
8606
|
+
static names(): {
|
|
8607
|
+
[key: string]: string;
|
|
8608
|
+
};
|
|
8609
|
+
static types(): {
|
|
8610
|
+
[key: string]: any;
|
|
8611
|
+
};
|
|
8612
|
+
constructor(map?: {
|
|
8613
|
+
[key: string]: any;
|
|
8614
|
+
});
|
|
8615
|
+
}
|
|
8316
8616
|
export declare class NotificationStrategyEscalationSettingCustomChannels extends $tea.Model {
|
|
8317
8617
|
channelType?: string;
|
|
8318
8618
|
severities?: string[];
|
|
@@ -10098,6 +10398,31 @@ export declare class DescribeEventRuleAttributeResponseBodyResultEventPatternEve
|
|
|
10098
10398
|
[key: string]: any;
|
|
10099
10399
|
});
|
|
10100
10400
|
}
|
|
10401
|
+
export declare class DescribeEventRuleAttributeResponseBodyResultEventPatternKeywordFilterObjKeywords extends $tea.Model {
|
|
10402
|
+
keyword?: string[];
|
|
10403
|
+
static names(): {
|
|
10404
|
+
[key: string]: string;
|
|
10405
|
+
};
|
|
10406
|
+
static types(): {
|
|
10407
|
+
[key: string]: any;
|
|
10408
|
+
};
|
|
10409
|
+
constructor(map?: {
|
|
10410
|
+
[key: string]: any;
|
|
10411
|
+
});
|
|
10412
|
+
}
|
|
10413
|
+
export declare class DescribeEventRuleAttributeResponseBodyResultEventPatternKeywordFilterObj extends $tea.Model {
|
|
10414
|
+
keywords?: DescribeEventRuleAttributeResponseBodyResultEventPatternKeywordFilterObjKeywords;
|
|
10415
|
+
relation?: string;
|
|
10416
|
+
static names(): {
|
|
10417
|
+
[key: string]: string;
|
|
10418
|
+
};
|
|
10419
|
+
static types(): {
|
|
10420
|
+
[key: string]: any;
|
|
10421
|
+
};
|
|
10422
|
+
constructor(map?: {
|
|
10423
|
+
[key: string]: any;
|
|
10424
|
+
});
|
|
10425
|
+
}
|
|
10101
10426
|
export declare class DescribeEventRuleAttributeResponseBodyResultEventPatternLevelList extends $tea.Model {
|
|
10102
10427
|
levelList?: string[];
|
|
10103
10428
|
static names(): {
|
|
@@ -10136,9 +10461,11 @@ export declare class DescribeEventRuleAttributeResponseBodyResultEventPatternSta
|
|
|
10136
10461
|
}
|
|
10137
10462
|
export declare class DescribeEventRuleAttributeResponseBodyResultEventPattern extends $tea.Model {
|
|
10138
10463
|
eventTypeList?: DescribeEventRuleAttributeResponseBodyResultEventPatternEventTypeList;
|
|
10464
|
+
keywordFilterObj?: DescribeEventRuleAttributeResponseBodyResultEventPatternKeywordFilterObj;
|
|
10139
10465
|
levelList?: DescribeEventRuleAttributeResponseBodyResultEventPatternLevelList;
|
|
10140
10466
|
nameList?: DescribeEventRuleAttributeResponseBodyResultEventPatternNameList;
|
|
10141
10467
|
product?: string;
|
|
10468
|
+
SQLFilter?: string;
|
|
10142
10469
|
statusList?: DescribeEventRuleAttributeResponseBodyResultEventPatternStatusList;
|
|
10143
10470
|
static names(): {
|
|
10144
10471
|
[key: string]: string;
|
|
@@ -12656,6 +12983,7 @@ export declare class DescribeSiteMonitorAttributeResponseBodySiteMonitorsOptionJ
|
|
|
12656
12983
|
trafficHijackElementCount?: number;
|
|
12657
12984
|
trafficHijackElementWhitelist?: DescribeSiteMonitorAttributeResponseBodySiteMonitorsOptionJsonTrafficHijackElementWhitelist;
|
|
12658
12985
|
username?: string;
|
|
12986
|
+
waitTimeAfterCompletion?: number;
|
|
12659
12987
|
static names(): {
|
|
12660
12988
|
[key: string]: string;
|
|
12661
12989
|
};
|
|
@@ -14266,9 +14594,7 @@ export default class Client extends OpenApi {
|
|
|
14266
14594
|
[key: string]: string;
|
|
14267
14595
|
}, endpoint: string): string;
|
|
14268
14596
|
/**
|
|
14269
|
-
*
|
|
14270
|
-
* * true: The call was successful.
|
|
14271
|
-
* * false: The call failed.
|
|
14597
|
+
* This topic provides an example on how to add a tag to an application group whose ID is `7301****`. In this example, the key of the tag is `key1` and the value of the tag is `value1`.
|
|
14272
14598
|
*
|
|
14273
14599
|
* @param request AddTagsRequest
|
|
14274
14600
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -14276,9 +14602,7 @@ export default class Client extends OpenApi {
|
|
|
14276
14602
|
*/
|
|
14277
14603
|
addTagsWithOptions(request: AddTagsRequest, runtime: $Util.RuntimeOptions): Promise<AddTagsResponse>;
|
|
14278
14604
|
/**
|
|
14279
|
-
*
|
|
14280
|
-
* * true: The call was successful.
|
|
14281
|
-
* * false: The call failed.
|
|
14605
|
+
* This topic provides an example on how to add a tag to an application group whose ID is `7301****`. In this example, the key of the tag is `key1` and the value of the tag is `value1`.
|
|
14282
14606
|
*
|
|
14283
14607
|
* @param request AddTagsRequest
|
|
14284
14608
|
* @return AddTagsResponse
|
|
@@ -14331,7 +14655,26 @@ export default class Client extends OpenApi {
|
|
|
14331
14655
|
* @return BatchCreateIntantSiteMonitorResponse
|
|
14332
14656
|
*/
|
|
14333
14657
|
batchCreateIntantSiteMonitor(request: BatchCreateIntantSiteMonitorRequest): Promise<BatchCreateIntantSiteMonitorResponse>;
|
|
14658
|
+
/**
|
|
14659
|
+
* ### [](#)Prerequisites
|
|
14660
|
+
* The `Cursor` information is returned by calling the [Cursor](~~2330730~~) operation.
|
|
14661
|
+
* ### [](#)Description
|
|
14662
|
+
* This topic provides an example on how to export the monitoring data of the `cpu_idle` metric for Elastic Compute Service (ECS). The namespace of ECS is `acs_ecs_dashboard`. The `Cursor` information is specified. A maximum of 1,000 data entries can be returned in each response.
|
|
14663
|
+
*
|
|
14664
|
+
* @param tmpReq BatchExportRequest
|
|
14665
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
14666
|
+
* @return BatchExportResponse
|
|
14667
|
+
*/
|
|
14334
14668
|
batchExportWithOptions(tmpReq: BatchExportRequest, runtime: $Util.RuntimeOptions): Promise<BatchExportResponse>;
|
|
14669
|
+
/**
|
|
14670
|
+
* ### [](#)Prerequisites
|
|
14671
|
+
* The `Cursor` information is returned by calling the [Cursor](~~2330730~~) operation.
|
|
14672
|
+
* ### [](#)Description
|
|
14673
|
+
* This topic provides an example on how to export the monitoring data of the `cpu_idle` metric for Elastic Compute Service (ECS). The namespace of ECS is `acs_ecs_dashboard`. The `Cursor` information is specified. A maximum of 1,000 data entries can be returned in each response.
|
|
14674
|
+
*
|
|
14675
|
+
* @param request BatchExportRequest
|
|
14676
|
+
* @return BatchExportResponse
|
|
14677
|
+
*/
|
|
14335
14678
|
batchExport(request: BatchExportRequest): Promise<BatchExportResponse>;
|
|
14336
14679
|
createCmsCallNumOrderWithOptions(request: CreateCmsCallNumOrderRequest, runtime: $Util.RuntimeOptions): Promise<CreateCmsCallNumOrderResponse>;
|
|
14337
14680
|
createCmsCallNumOrder(request: CreateCmsCallNumOrderRequest): Promise<CreateCmsCallNumOrderResponse>;
|
|
@@ -14376,7 +14719,7 @@ export default class Client extends OpenApi {
|
|
|
14376
14719
|
createGroupMonitoringAgentProcessWithOptions(request: CreateGroupMonitoringAgentProcessRequest, runtime: $Util.RuntimeOptions): Promise<CreateGroupMonitoringAgentProcessResponse>;
|
|
14377
14720
|
createGroupMonitoringAgentProcess(request: CreateGroupMonitoringAgentProcessRequest): Promise<CreateGroupMonitoringAgentProcessResponse>;
|
|
14378
14721
|
/**
|
|
14379
|
-
* The
|
|
14722
|
+
* This topic provides an example on how to create an availability monitoring task named `task1` in an application group named `123456`. The TaskType parameter of the task is set to `HTTP`. After you start the task, the system sends alerts by using the specified email address and DingTalk chatbot.
|
|
14380
14723
|
*
|
|
14381
14724
|
* @param request CreateHostAvailabilityRequest
|
|
14382
14725
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -14384,7 +14727,7 @@ export default class Client extends OpenApi {
|
|
|
14384
14727
|
*/
|
|
14385
14728
|
createHostAvailabilityWithOptions(request: CreateHostAvailabilityRequest, runtime: $Util.RuntimeOptions): Promise<CreateHostAvailabilityResponse>;
|
|
14386
14729
|
/**
|
|
14387
|
-
* The
|
|
14730
|
+
* This topic provides an example on how to create an availability monitoring task named `task1` in an application group named `123456`. The TaskType parameter of the task is set to `HTTP`. After you start the task, the system sends alerts by using the specified email address and DingTalk chatbot.
|
|
14388
14731
|
*
|
|
14389
14732
|
* @param request CreateHostAvailabilityRequest
|
|
14390
14733
|
* @return CreateHostAvailabilityResponse
|
|
@@ -14459,8 +14802,9 @@ export default class Client extends OpenApi {
|
|
|
14459
14802
|
*/
|
|
14460
14803
|
createInstantSiteMonitor(request: CreateInstantSiteMonitorRequest): Promise<CreateInstantSiteMonitorResponse>;
|
|
14461
14804
|
/**
|
|
14462
|
-
*
|
|
14463
|
-
*
|
|
14805
|
+
* ### Background information
|
|
14806
|
+
* * CloudMonitor blocks alert notifications based on the blacklist policies that take effect. To block alert notifications when the value of a metric that belongs to a cloud service reaches the threshold that you specified, add the metric to a blacklist policy.
|
|
14807
|
+
* * CloudMonitor allows you to create blacklist policies only based on threshold metrics. You cannot create blacklist policies based on system events. For more information about the cloud services and the thresholds of the metrics that are supported by CloudMonitor, see [Appendix 1: Metrics](~~163515~~).
|
|
14464
14808
|
*
|
|
14465
14809
|
* @param request CreateMetricRuleBlackListRequest
|
|
14466
14810
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -14468,8 +14812,9 @@ export default class Client extends OpenApi {
|
|
|
14468
14812
|
*/
|
|
14469
14813
|
createMetricRuleBlackListWithOptions(request: CreateMetricRuleBlackListRequest, runtime: $Util.RuntimeOptions): Promise<CreateMetricRuleBlackListResponse>;
|
|
14470
14814
|
/**
|
|
14471
|
-
*
|
|
14472
|
-
*
|
|
14815
|
+
* ### Background information
|
|
14816
|
+
* * CloudMonitor blocks alert notifications based on the blacklist policies that take effect. To block alert notifications when the value of a metric that belongs to a cloud service reaches the threshold that you specified, add the metric to a blacklist policy.
|
|
14817
|
+
* * CloudMonitor allows you to create blacklist policies only based on threshold metrics. You cannot create blacklist policies based on system events. For more information about the cloud services and the thresholds of the metrics that are supported by CloudMonitor, see [Appendix 1: Metrics](~~163515~~).
|
|
14473
14818
|
*
|
|
14474
14819
|
* @param request CreateMetricRuleBlackListRequest
|
|
14475
14820
|
* @return CreateMetricRuleBlackListResponse
|
|
@@ -14497,8 +14842,7 @@ export default class Client extends OpenApi {
|
|
|
14497
14842
|
*/
|
|
14498
14843
|
createMonitorGroup(request: CreateMonitorGroupRequest): Promise<CreateMonitorGroupResponse>;
|
|
14499
14844
|
/**
|
|
14500
|
-
*
|
|
14501
|
-
* For information about how to obtain the ID of the region where a resource group resides, see [GetResourceGroup](~~158866~~).
|
|
14845
|
+
* This topic provides an example on how to create an application group by using the resource group `CloudMonitor` and the alert contact group `ECS_Group`. The region ID of the resource group is `cn-hangzhou`.
|
|
14502
14846
|
*
|
|
14503
14847
|
* @param request CreateMonitorGroupByResourceGroupIdRequest
|
|
14504
14848
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -14506,8 +14850,7 @@ export default class Client extends OpenApi {
|
|
|
14506
14850
|
*/
|
|
14507
14851
|
createMonitorGroupByResourceGroupIdWithOptions(request: CreateMonitorGroupByResourceGroupIdRequest, runtime: $Util.RuntimeOptions): Promise<CreateMonitorGroupByResourceGroupIdResponse>;
|
|
14508
14852
|
/**
|
|
14509
|
-
*
|
|
14510
|
-
* For information about how to obtain the ID of the region where a resource group resides, see [GetResourceGroup](~~158866~~).
|
|
14853
|
+
* This topic provides an example on how to create an application group by using the resource group `CloudMonitor` and the alert contact group `ECS_Group`. The region ID of the resource group is `cn-hangzhou`.
|
|
14511
14854
|
*
|
|
14512
14855
|
* @param request CreateMonitorGroupByResourceGroupIdRequest
|
|
14513
14856
|
* @return CreateMonitorGroupByResourceGroupIdResponse
|
|
@@ -14548,9 +14891,7 @@ export default class Client extends OpenApi {
|
|
|
14548
14891
|
createMonitoringAgentProcessWithOptions(request: CreateMonitoringAgentProcessRequest, runtime: $Util.RuntimeOptions): Promise<CreateMonitoringAgentProcessResponse>;
|
|
14549
14892
|
createMonitoringAgentProcess(request: CreateMonitoringAgentProcessRequest): Promise<CreateMonitoringAgentProcessResponse>;
|
|
14550
14893
|
/**
|
|
14551
|
-
*
|
|
14552
|
-
* * true: The call was successful.
|
|
14553
|
-
* * false: The call failed.
|
|
14894
|
+
* This topic provides an example on how to create a site monitoring task named `HanZhou_ECS1`. The URL that is monitored by the task is `https://www.aliyun.com` and the type of the task is `HTTPS`.
|
|
14554
14895
|
*
|
|
14555
14896
|
* @param request CreateSiteMonitorRequest
|
|
14556
14897
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -14558,15 +14899,36 @@ export default class Client extends OpenApi {
|
|
|
14558
14899
|
*/
|
|
14559
14900
|
createSiteMonitorWithOptions(request: CreateSiteMonitorRequest, runtime: $Util.RuntimeOptions): Promise<CreateSiteMonitorResponse>;
|
|
14560
14901
|
/**
|
|
14561
|
-
*
|
|
14562
|
-
* * true: The call was successful.
|
|
14563
|
-
* * false: The call failed.
|
|
14902
|
+
* This topic provides an example on how to create a site monitoring task named `HanZhou_ECS1`. The URL that is monitored by the task is `https://www.aliyun.com` and the type of the task is `HTTPS`.
|
|
14564
14903
|
*
|
|
14565
14904
|
* @param request CreateSiteMonitorRequest
|
|
14566
14905
|
* @return CreateSiteMonitorResponse
|
|
14567
14906
|
*/
|
|
14568
14907
|
createSiteMonitor(request: CreateSiteMonitorRequest): Promise<CreateSiteMonitorResponse>;
|
|
14908
|
+
/**
|
|
14909
|
+
* ### [](#)Prerequisites
|
|
14910
|
+
* Hybrid Cloud Monitoring is activated. For more information, see [Activate Hybrid Cloud Monitoring](~~250773~~).
|
|
14911
|
+
* ### [](#)Background information
|
|
14912
|
+
* You can call this operation to obtain the Cursor information and then call the [BatchExport](~~2329847~~) operation to export the monitoring data.
|
|
14913
|
+
* ### [](#)Description
|
|
14914
|
+
* This topic provides an example on how to define the monitoring data of a specified metric for a specified cloud service. In this example, the namespace of the cloud service is set to `acs_ecs_dashboard`, the metric is set to `cpu_idle`, the start time is set to `1641627000000`, and the end time is set to `1641645000000`. The number of idle CPU cores on your Elastic Compute Service (ECS) instances is measured every 60 seconds from 15:30:00, January 8, 2022 to 20:30:00, January 8, 2022. The `Cursor` information is returned.
|
|
14915
|
+
*
|
|
14916
|
+
* @param tmpReq CursorRequest
|
|
14917
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
14918
|
+
* @return CursorResponse
|
|
14919
|
+
*/
|
|
14569
14920
|
cursorWithOptions(tmpReq: CursorRequest, runtime: $Util.RuntimeOptions): Promise<CursorResponse>;
|
|
14921
|
+
/**
|
|
14922
|
+
* ### [](#)Prerequisites
|
|
14923
|
+
* Hybrid Cloud Monitoring is activated. For more information, see [Activate Hybrid Cloud Monitoring](~~250773~~).
|
|
14924
|
+
* ### [](#)Background information
|
|
14925
|
+
* You can call this operation to obtain the Cursor information and then call the [BatchExport](~~2329847~~) operation to export the monitoring data.
|
|
14926
|
+
* ### [](#)Description
|
|
14927
|
+
* This topic provides an example on how to define the monitoring data of a specified metric for a specified cloud service. In this example, the namespace of the cloud service is set to `acs_ecs_dashboard`, the metric is set to `cpu_idle`, the start time is set to `1641627000000`, and the end time is set to `1641645000000`. The number of idle CPU cores on your Elastic Compute Service (ECS) instances is measured every 60 seconds from 15:30:00, January 8, 2022 to 20:30:00, January 8, 2022. The `Cursor` information is returned.
|
|
14928
|
+
*
|
|
14929
|
+
* @param request CursorRequest
|
|
14930
|
+
* @return CursorResponse
|
|
14931
|
+
*/
|
|
14570
14932
|
cursor(request: CursorRequest): Promise<CursorResponse>;
|
|
14571
14933
|
deleteContactWithOptions(request: DeleteContactRequest, runtime: $Util.RuntimeOptions): Promise<DeleteContactResponse>;
|
|
14572
14934
|
deleteContact(request: DeleteContactRequest): Promise<DeleteContactResponse>;
|
|
@@ -14608,9 +14970,7 @@ export default class Client extends OpenApi {
|
|
|
14608
14970
|
*/
|
|
14609
14971
|
deleteHybridMonitorNamespace(request: DeleteHybridMonitorNamespaceRequest): Promise<DeleteHybridMonitorNamespaceResponse>;
|
|
14610
14972
|
/**
|
|
14611
|
-
*
|
|
14612
|
-
* * true: The call is successful.
|
|
14613
|
-
* * false: The call fails.
|
|
14973
|
+
* This topic provides an example on how to delete a Logstore group named `Logstore_test`. The response shows that the Logstore group is deleted.
|
|
14614
14974
|
*
|
|
14615
14975
|
* @param request DeleteHybridMonitorSLSGroupRequest
|
|
14616
14976
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -14618,18 +14978,14 @@ export default class Client extends OpenApi {
|
|
|
14618
14978
|
*/
|
|
14619
14979
|
deleteHybridMonitorSLSGroupWithOptions(request: DeleteHybridMonitorSLSGroupRequest, runtime: $Util.RuntimeOptions): Promise<DeleteHybridMonitorSLSGroupResponse>;
|
|
14620
14980
|
/**
|
|
14621
|
-
*
|
|
14622
|
-
* * true: The call is successful.
|
|
14623
|
-
* * false: The call fails.
|
|
14981
|
+
* This topic provides an example on how to delete a Logstore group named `Logstore_test`. The response shows that the Logstore group is deleted.
|
|
14624
14982
|
*
|
|
14625
14983
|
* @param request DeleteHybridMonitorSLSGroupRequest
|
|
14626
14984
|
* @return DeleteHybridMonitorSLSGroupResponse
|
|
14627
14985
|
*/
|
|
14628
14986
|
deleteHybridMonitorSLSGroup(request: DeleteHybridMonitorSLSGroupRequest): Promise<DeleteHybridMonitorSLSGroupResponse>;
|
|
14629
14987
|
/**
|
|
14630
|
-
*
|
|
14631
|
-
* * true: The call was successful.
|
|
14632
|
-
* * false: The call failed.
|
|
14988
|
+
* This topic provides an example on how to delete a metric import task whose ID is `36****`. The returned result indicates that the metric import task is deleted.
|
|
14633
14989
|
*
|
|
14634
14990
|
* @param request DeleteHybridMonitorTaskRequest
|
|
14635
14991
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -14637,9 +14993,7 @@ export default class Client extends OpenApi {
|
|
|
14637
14993
|
*/
|
|
14638
14994
|
deleteHybridMonitorTaskWithOptions(request: DeleteHybridMonitorTaskRequest, runtime: $Util.RuntimeOptions): Promise<DeleteHybridMonitorTaskResponse>;
|
|
14639
14995
|
/**
|
|
14640
|
-
*
|
|
14641
|
-
* * true: The call was successful.
|
|
14642
|
-
* * false: The call failed.
|
|
14996
|
+
* This topic provides an example on how to delete a metric import task whose ID is `36****`. The returned result indicates that the metric import task is deleted.
|
|
14643
14997
|
*
|
|
14644
14998
|
* @param request DeleteHybridMonitorTaskRequest
|
|
14645
14999
|
* @return DeleteHybridMonitorTaskResponse
|
|
@@ -14704,7 +15058,7 @@ export default class Client extends OpenApi {
|
|
|
14704
15058
|
*/
|
|
14705
15059
|
describeAlertLogCount(request: DescribeAlertLogCountRequest): Promise<DescribeAlertLogCountResponse>;
|
|
14706
15060
|
/**
|
|
14707
|
-
*
|
|
15061
|
+
* This topic provides an example on how to query the number of alert logs for Elastic Compute Service (ECS) based on the `product` dimension.
|
|
14708
15062
|
*
|
|
14709
15063
|
* @param request DescribeAlertLogHistogramRequest
|
|
14710
15064
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -14712,7 +15066,7 @@ export default class Client extends OpenApi {
|
|
|
14712
15066
|
*/
|
|
14713
15067
|
describeAlertLogHistogramWithOptions(request: DescribeAlertLogHistogramRequest, runtime: $Util.RuntimeOptions): Promise<DescribeAlertLogHistogramResponse>;
|
|
14714
15068
|
/**
|
|
14715
|
-
*
|
|
15069
|
+
* This topic provides an example on how to query the number of alert logs for Elastic Compute Service (ECS) based on the `product` dimension.
|
|
14716
15070
|
*
|
|
14717
15071
|
* @param request DescribeAlertLogHistogramRequest
|
|
14718
15072
|
* @return DescribeAlertLogHistogramResponse
|
|
@@ -14799,8 +15153,7 @@ export default class Client extends OpenApi {
|
|
|
14799
15153
|
*/
|
|
14800
15154
|
describeDynamicTagRuleList(request: DescribeDynamicTagRuleListRequest): Promise<DescribeDynamicTagRuleListResponse>;
|
|
14801
15155
|
/**
|
|
14802
|
-
*
|
|
14803
|
-
* For information about how to obtain the name of an event-triggered alert rule, see [DescribeEventRuleList](~~114996~~).
|
|
15156
|
+
* This topic provides an example to show how to query the details of an event-triggered alert rule named `testRule`.
|
|
14804
15157
|
*
|
|
14805
15158
|
* @param request DescribeEventRuleAttributeRequest
|
|
14806
15159
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -14808,8 +15161,7 @@ export default class Client extends OpenApi {
|
|
|
14808
15161
|
*/
|
|
14809
15162
|
describeEventRuleAttributeWithOptions(request: DescribeEventRuleAttributeRequest, runtime: $Util.RuntimeOptions): Promise<DescribeEventRuleAttributeResponse>;
|
|
14810
15163
|
/**
|
|
14811
|
-
*
|
|
14812
|
-
* For information about how to obtain the name of an event-triggered alert rule, see [DescribeEventRuleList](~~114996~~).
|
|
15164
|
+
* This topic provides an example to show how to query the details of an event-triggered alert rule named `testRule`.
|
|
14813
15165
|
*
|
|
14814
15166
|
* @param request DescribeEventRuleAttributeRequest
|
|
14815
15167
|
* @return DescribeEventRuleAttributeResponse
|
|
@@ -14909,9 +15261,7 @@ export default class Client extends OpenApi {
|
|
|
14909
15261
|
*/
|
|
14910
15262
|
describeHybridMonitorNamespaceList(request: DescribeHybridMonitorNamespaceListRequest): Promise<DescribeHybridMonitorNamespaceListResponse>;
|
|
14911
15263
|
/**
|
|
14912
|
-
*
|
|
14913
|
-
* * true: The call is successful.
|
|
14914
|
-
* * false: The call fails.
|
|
15264
|
+
* In this example, all Logstore groups within the current account are queried. The response shows that the current account has two Logstore groups: `Logstore_test` and `Logstore_aliyun`.
|
|
14915
15265
|
*
|
|
14916
15266
|
* @param request DescribeHybridMonitorSLSGroupRequest
|
|
14917
15267
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -14919,18 +15269,14 @@ export default class Client extends OpenApi {
|
|
|
14919
15269
|
*/
|
|
14920
15270
|
describeHybridMonitorSLSGroupWithOptions(request: DescribeHybridMonitorSLSGroupRequest, runtime: $Util.RuntimeOptions): Promise<DescribeHybridMonitorSLSGroupResponse>;
|
|
14921
15271
|
/**
|
|
14922
|
-
*
|
|
14923
|
-
* * true: The call is successful.
|
|
14924
|
-
* * false: The call fails.
|
|
15272
|
+
* In this example, all Logstore groups within the current account are queried. The response shows that the current account has two Logstore groups: `Logstore_test` and `Logstore_aliyun`.
|
|
14925
15273
|
*
|
|
14926
15274
|
* @param request DescribeHybridMonitorSLSGroupRequest
|
|
14927
15275
|
* @return DescribeHybridMonitorSLSGroupResponse
|
|
14928
15276
|
*/
|
|
14929
15277
|
describeHybridMonitorSLSGroup(request: DescribeHybridMonitorSLSGroupRequest): Promise<DescribeHybridMonitorSLSGroupResponse>;
|
|
14930
15278
|
/**
|
|
14931
|
-
*
|
|
14932
|
-
* * true: The call was successful.
|
|
14933
|
-
* * false: The call failed.
|
|
15279
|
+
* This topic provides an example on how to query all metric import tasks that belong to the current Alibaba Cloud account. The returned result indicates that the current account has only one metric import task. The metric import task is named `aliyun_task`.
|
|
14934
15280
|
*
|
|
14935
15281
|
* @param request DescribeHybridMonitorTaskListRequest
|
|
14936
15282
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -14938,9 +15284,7 @@ export default class Client extends OpenApi {
|
|
|
14938
15284
|
*/
|
|
14939
15285
|
describeHybridMonitorTaskListWithOptions(request: DescribeHybridMonitorTaskListRequest, runtime: $Util.RuntimeOptions): Promise<DescribeHybridMonitorTaskListResponse>;
|
|
14940
15286
|
/**
|
|
14941
|
-
*
|
|
14942
|
-
* * true: The call was successful.
|
|
14943
|
-
* * false: The call failed.
|
|
15287
|
+
* This topic provides an example on how to query all metric import tasks that belong to the current Alibaba Cloud account. The returned result indicates that the current account has only one metric import task. The metric import task is named `aliyun_task`.
|
|
14944
15288
|
*
|
|
14945
15289
|
* @param request DescribeHybridMonitorTaskListRequest
|
|
14946
15290
|
* @return DescribeHybridMonitorTaskListResponse
|
|
@@ -14976,9 +15320,15 @@ export default class Client extends OpenApi {
|
|
|
14976
15320
|
*/
|
|
14977
15321
|
describeMetricData(request: DescribeMetricDataRequest): Promise<DescribeMetricDataResponse>;
|
|
14978
15322
|
/**
|
|
14979
|
-
*
|
|
14980
|
-
*
|
|
14981
|
-
*
|
|
15323
|
+
* ### [](#)Limits
|
|
15324
|
+
* Each API operation can be called up to 50 times per second. An Alibaba Cloud account and the RAM users within the account share the quota.
|
|
15325
|
+
* ### [](#)Precautions
|
|
15326
|
+
* The storage duration of the monitoring data of each cloud service is related to the `Period` parameter (statistical period). A larger value of the `Period` parameter indicates that the monitoring data is distributed in a larger time range and the storage duration of the monitoring data is longer. The following list describes the specific relationships:
|
|
15327
|
+
* * If the value of the `Period` parameter is less than 60 seconds, the storage duration is seven days.
|
|
15328
|
+
* * If the value of the `Period` parameter is 60 seconds, the storage duration is 31 days.
|
|
15329
|
+
* * If the value of the `Period` parameter is 300 seconds, the storage duration is 91 days.
|
|
15330
|
+
* ### [](#)Description
|
|
15331
|
+
* This topic provides an example on how to query the latest monitoring data of the `CPUUtilization` metric for Elastic Compute Service (ECS). The namespace of ECS is `acs_ecs_dashboard`. The returned result indicates that the monitoring data for the instance `i-abcdefgh12****` of the account `123456789876****` is queried at an interval of 60 seconds. The maximum, minimum, and average values of the metric are 100, 93.1, and 99.52.
|
|
14982
15332
|
*
|
|
14983
15333
|
* @param request DescribeMetricLastRequest
|
|
14984
15334
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -14986,9 +15336,15 @@ export default class Client extends OpenApi {
|
|
|
14986
15336
|
*/
|
|
14987
15337
|
describeMetricLastWithOptions(request: DescribeMetricLastRequest, runtime: $Util.RuntimeOptions): Promise<DescribeMetricLastResponse>;
|
|
14988
15338
|
/**
|
|
14989
|
-
*
|
|
14990
|
-
*
|
|
14991
|
-
*
|
|
15339
|
+
* ### [](#)Limits
|
|
15340
|
+
* Each API operation can be called up to 50 times per second. An Alibaba Cloud account and the RAM users within the account share the quota.
|
|
15341
|
+
* ### [](#)Precautions
|
|
15342
|
+
* The storage duration of the monitoring data of each cloud service is related to the `Period` parameter (statistical period). A larger value of the `Period` parameter indicates that the monitoring data is distributed in a larger time range and the storage duration of the monitoring data is longer. The following list describes the specific relationships:
|
|
15343
|
+
* * If the value of the `Period` parameter is less than 60 seconds, the storage duration is seven days.
|
|
15344
|
+
* * If the value of the `Period` parameter is 60 seconds, the storage duration is 31 days.
|
|
15345
|
+
* * If the value of the `Period` parameter is 300 seconds, the storage duration is 91 days.
|
|
15346
|
+
* ### [](#)Description
|
|
15347
|
+
* This topic provides an example on how to query the latest monitoring data of the `CPUUtilization` metric for Elastic Compute Service (ECS). The namespace of ECS is `acs_ecs_dashboard`. The returned result indicates that the monitoring data for the instance `i-abcdefgh12****` of the account `123456789876****` is queried at an interval of 60 seconds. The maximum, minimum, and average values of the metric are 100, 93.1, and 99.52.
|
|
14992
15348
|
*
|
|
14993
15349
|
* @param request DescribeMetricLastRequest
|
|
14994
15350
|
* @return DescribeMetricLastResponse
|
|
@@ -15078,8 +15434,7 @@ export default class Client extends OpenApi {
|
|
|
15078
15434
|
*/
|
|
15079
15435
|
describeMetricRuleTemplateAttribute(request: DescribeMetricRuleTemplateAttributeRequest): Promise<DescribeMetricRuleTemplateAttributeResponse>;
|
|
15080
15436
|
/**
|
|
15081
|
-
*
|
|
15082
|
-
* > The status code 200 indicates that the call was successful.
|
|
15437
|
+
* This topic provides an example on how to query alert templates. In this example, the following alert templates are returned in the response: `ECS_Template1` and `ECS_Template2`.
|
|
15083
15438
|
*
|
|
15084
15439
|
* @param request DescribeMetricRuleTemplateListRequest
|
|
15085
15440
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -15087,17 +15442,22 @@ export default class Client extends OpenApi {
|
|
|
15087
15442
|
*/
|
|
15088
15443
|
describeMetricRuleTemplateListWithOptions(request: DescribeMetricRuleTemplateListRequest, runtime: $Util.RuntimeOptions): Promise<DescribeMetricRuleTemplateListResponse>;
|
|
15089
15444
|
/**
|
|
15090
|
-
*
|
|
15091
|
-
* > The status code 200 indicates that the call was successful.
|
|
15445
|
+
* This topic provides an example on how to query alert templates. In this example, the following alert templates are returned in the response: `ECS_Template1` and `ECS_Template2`.
|
|
15092
15446
|
*
|
|
15093
15447
|
* @param request DescribeMetricRuleTemplateListRequest
|
|
15094
15448
|
* @return DescribeMetricRuleTemplateListResponse
|
|
15095
15449
|
*/
|
|
15096
15450
|
describeMetricRuleTemplateList(request: DescribeMetricRuleTemplateListRequest): Promise<DescribeMetricRuleTemplateListResponse>;
|
|
15097
15451
|
/**
|
|
15098
|
-
*
|
|
15099
|
-
*
|
|
15100
|
-
*
|
|
15452
|
+
* ### [](#)Limits
|
|
15453
|
+
* Each API operation can be called up to 10 times per second. An Alibaba Cloud account and the RAM users within the account share the quota.
|
|
15454
|
+
* ### [](#)Precautions
|
|
15455
|
+
* The storage duration of the monitoring data of each cloud service is related to the `Period` parameter (statistical period). A larger value of the `Period` parameter indicates that the monitoring data is distributed in a larger time range and the storage duration of the monitoring data is longer. The following list describes the specific relationships:
|
|
15456
|
+
* * If the value of the `Period` parameter is less than 60 seconds, the storage duration is seven days.
|
|
15457
|
+
* * If the value of the `Period` parameter is 60 seconds, the storage duration is 31 days.
|
|
15458
|
+
* * If the value of the `Period` parameter is 300 seconds, the storage duration is 91 days.
|
|
15459
|
+
* ### [](#)Description
|
|
15460
|
+
* This topic provides an example to show how to query the monitoring data of the `cpu_idle` metric in the last 60 seconds for Elastic Compute Service (ECS). The namespace of ECS is `acs_ecs_dashboard`. The monitoring data is sorted in the descending order based on the `Average` field.
|
|
15101
15461
|
*
|
|
15102
15462
|
* @param request DescribeMetricTopRequest
|
|
15103
15463
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -15105,9 +15465,15 @@ export default class Client extends OpenApi {
|
|
|
15105
15465
|
*/
|
|
15106
15466
|
describeMetricTopWithOptions(request: DescribeMetricTopRequest, runtime: $Util.RuntimeOptions): Promise<DescribeMetricTopResponse>;
|
|
15107
15467
|
/**
|
|
15108
|
-
*
|
|
15109
|
-
*
|
|
15110
|
-
*
|
|
15468
|
+
* ### [](#)Limits
|
|
15469
|
+
* Each API operation can be called up to 10 times per second. An Alibaba Cloud account and the RAM users within the account share the quota.
|
|
15470
|
+
* ### [](#)Precautions
|
|
15471
|
+
* The storage duration of the monitoring data of each cloud service is related to the `Period` parameter (statistical period). A larger value of the `Period` parameter indicates that the monitoring data is distributed in a larger time range and the storage duration of the monitoring data is longer. The following list describes the specific relationships:
|
|
15472
|
+
* * If the value of the `Period` parameter is less than 60 seconds, the storage duration is seven days.
|
|
15473
|
+
* * If the value of the `Period` parameter is 60 seconds, the storage duration is 31 days.
|
|
15474
|
+
* * If the value of the `Period` parameter is 300 seconds, the storage duration is 91 days.
|
|
15475
|
+
* ### [](#)Description
|
|
15476
|
+
* This topic provides an example to show how to query the monitoring data of the `cpu_idle` metric in the last 60 seconds for Elastic Compute Service (ECS). The namespace of ECS is `acs_ecs_dashboard`. The monitoring data is sorted in the descending order based on the `Average` field.
|
|
15111
15477
|
*
|
|
15112
15478
|
* @param request DescribeMetricTopRequest
|
|
15113
15479
|
* @return DescribeMetricTopResponse
|
|
@@ -15162,12 +15528,7 @@ export default class Client extends OpenApi {
|
|
|
15162
15528
|
*/
|
|
15163
15529
|
describeMonitoringAgentProcesses(request: DescribeMonitoringAgentProcessesRequest): Promise<DescribeMonitoringAgentProcessesResponse>;
|
|
15164
15530
|
/**
|
|
15165
|
-
*
|
|
15166
|
-
* * `Command.ErrorCode.Fail.Downlaod.REGIN_ID`: Failed to obtain the region ID.
|
|
15167
|
-
* * `Command.ErrorCode.Fail.Downlaod.SYSAK`: Failed to download the .rpm package of System Analyse Kit (SysAK).
|
|
15168
|
-
* * `Command.ErrorCode.Fail.Downlaod.CMON_FILE`: Failed to download the CMON file.
|
|
15169
|
-
* * `Command.ErrorCode.Fail.Downlaod.BTF`: Failed to start SysAK because the BTF file is not found.
|
|
15170
|
-
* * `Command.ErrorCode.Fail.Start.SYSAK`: Failed to start SysAK due to an unknown error.
|
|
15531
|
+
* This topic describes how to query the status of the CloudMonitor agent that is installed on the `i-hp3dunahluwajv6f****` instance. The result indicates that the CloudMonitor agent is in the `running` state.
|
|
15171
15532
|
*
|
|
15172
15533
|
* @param request DescribeMonitoringAgentStatusesRequest
|
|
15173
15534
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -15175,12 +15536,7 @@ export default class Client extends OpenApi {
|
|
|
15175
15536
|
*/
|
|
15176
15537
|
describeMonitoringAgentStatusesWithOptions(request: DescribeMonitoringAgentStatusesRequest, runtime: $Util.RuntimeOptions): Promise<DescribeMonitoringAgentStatusesResponse>;
|
|
15177
15538
|
/**
|
|
15178
|
-
*
|
|
15179
|
-
* * `Command.ErrorCode.Fail.Downlaod.REGIN_ID`: Failed to obtain the region ID.
|
|
15180
|
-
* * `Command.ErrorCode.Fail.Downlaod.SYSAK`: Failed to download the .rpm package of System Analyse Kit (SysAK).
|
|
15181
|
-
* * `Command.ErrorCode.Fail.Downlaod.CMON_FILE`: Failed to download the CMON file.
|
|
15182
|
-
* * `Command.ErrorCode.Fail.Downlaod.BTF`: Failed to start SysAK because the BTF file is not found.
|
|
15183
|
-
* * `Command.ErrorCode.Fail.Start.SYSAK`: Failed to start SysAK due to an unknown error.
|
|
15539
|
+
* This topic describes how to query the status of the CloudMonitor agent that is installed on the `i-hp3dunahluwajv6f****` instance. The result indicates that the CloudMonitor agent is in the `running` state.
|
|
15184
15540
|
*
|
|
15185
15541
|
* @param request DescribeMonitoringAgentStatusesRequest
|
|
15186
15542
|
* @return DescribeMonitoringAgentStatusesResponse
|
|
@@ -15372,9 +15728,7 @@ export default class Client extends OpenApi {
|
|
|
15372
15728
|
modifyGroupMonitoringAgentProcessWithOptions(request: ModifyGroupMonitoringAgentProcessRequest, runtime: $Util.RuntimeOptions): Promise<ModifyGroupMonitoringAgentProcessResponse>;
|
|
15373
15729
|
modifyGroupMonitoringAgentProcess(request: ModifyGroupMonitoringAgentProcessRequest): Promise<ModifyGroupMonitoringAgentProcessResponse>;
|
|
15374
15730
|
/**
|
|
15375
|
-
*
|
|
15376
|
-
* * true: The call was successful.
|
|
15377
|
-
* * false: The call failed.
|
|
15731
|
+
* This topic provides an example on how to change the name of an availability monitoring task named `12345` in an application group named `123456` to `task2`.
|
|
15378
15732
|
*
|
|
15379
15733
|
* @param request ModifyHostAvailabilityRequest
|
|
15380
15734
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -15382,9 +15736,7 @@ export default class Client extends OpenApi {
|
|
|
15382
15736
|
*/
|
|
15383
15737
|
modifyHostAvailabilityWithOptions(request: ModifyHostAvailabilityRequest, runtime: $Util.RuntimeOptions): Promise<ModifyHostAvailabilityResponse>;
|
|
15384
15738
|
/**
|
|
15385
|
-
*
|
|
15386
|
-
* * true: The call was successful.
|
|
15387
|
-
* * false: The call failed.
|
|
15739
|
+
* This topic provides an example on how to change the name of an availability monitoring task named `12345` in an application group named `123456` to `task2`.
|
|
15388
15740
|
*
|
|
15389
15741
|
* @param request ModifyHostAvailabilityRequest
|
|
15390
15742
|
* @return ModifyHostAvailabilityResponse
|
|
@@ -15442,7 +15794,7 @@ export default class Client extends OpenApi {
|
|
|
15442
15794
|
*/
|
|
15443
15795
|
modifyHybridMonitorSLSGroup(request: ModifyHybridMonitorSLSGroupRequest): Promise<ModifyHybridMonitorSLSGroupResponse>;
|
|
15444
15796
|
/**
|
|
15445
|
-
*
|
|
15797
|
+
* This topic provides an example on how to change the collection period of a metric import task whose ID is `36****` to `15` seconds. The task is used to monitor the logs that are imported from Log Service. The returned result indicates that the metric is modified.
|
|
15446
15798
|
*
|
|
15447
15799
|
* @param request ModifyHybridMonitorTaskRequest
|
|
15448
15800
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -15450,7 +15802,7 @@ export default class Client extends OpenApi {
|
|
|
15450
15802
|
*/
|
|
15451
15803
|
modifyHybridMonitorTaskWithOptions(request: ModifyHybridMonitorTaskRequest, runtime: $Util.RuntimeOptions): Promise<ModifyHybridMonitorTaskResponse>;
|
|
15452
15804
|
/**
|
|
15453
|
-
*
|
|
15805
|
+
* This topic provides an example on how to change the collection period of a metric import task whose ID is `36****` to `15` seconds. The task is used to monitor the logs that are imported from Log Service. The returned result indicates that the metric is modified.
|
|
15454
15806
|
*
|
|
15455
15807
|
* @param request ModifyHybridMonitorTaskRequest
|
|
15456
15808
|
* @return ModifyHybridMonitorTaskResponse
|
|
@@ -15617,9 +15969,7 @@ export default class Client extends OpenApi {
|
|
|
15617
15969
|
putExporterRuleWithOptions(request: PutExporterRuleRequest, runtime: $Util.RuntimeOptions): Promise<PutExporterRuleResponse>;
|
|
15618
15970
|
putExporterRule(request: PutExporterRuleRequest): Promise<PutExporterRuleResponse>;
|
|
15619
15971
|
/**
|
|
15620
|
-
*
|
|
15621
|
-
* * true: The call was successful.
|
|
15622
|
-
* * false: The call failed.
|
|
15972
|
+
* This topic provides an example on how to create an alert rule for the `cpu_total` metric of Elastic Compute Service (ECS) in the `17285****` application group. The ID of the alert rule is `123456`. The name of the alert rule is `Rule_test`. The alert level is `Critical`. The statistical method is `Average`. The alert threshold comparator is `GreaterThanOrEqualToThreshold`. The alert threshold is `90`. The number of alert retries is `3`. The returned result shows that the alert rule is created and the alert rule ID is `123456`.
|
|
15623
15973
|
*
|
|
15624
15974
|
* @param request PutGroupMetricRuleRequest
|
|
15625
15975
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -15627,18 +15977,19 @@ export default class Client extends OpenApi {
|
|
|
15627
15977
|
*/
|
|
15628
15978
|
putGroupMetricRuleWithOptions(request: PutGroupMetricRuleRequest, runtime: $Util.RuntimeOptions): Promise<PutGroupMetricRuleResponse>;
|
|
15629
15979
|
/**
|
|
15630
|
-
*
|
|
15631
|
-
* * true: The call was successful.
|
|
15632
|
-
* * false: The call failed.
|
|
15980
|
+
* This topic provides an example on how to create an alert rule for the `cpu_total` metric of Elastic Compute Service (ECS) in the `17285****` application group. The ID of the alert rule is `123456`. The name of the alert rule is `Rule_test`. The alert level is `Critical`. The statistical method is `Average`. The alert threshold comparator is `GreaterThanOrEqualToThreshold`. The alert threshold is `90`. The number of alert retries is `3`. The returned result shows that the alert rule is created and the alert rule ID is `123456`.
|
|
15633
15981
|
*
|
|
15634
15982
|
* @param request PutGroupMetricRuleRequest
|
|
15635
15983
|
* @return PutGroupMetricRuleResponse
|
|
15636
15984
|
*/
|
|
15637
15985
|
putGroupMetricRule(request: PutGroupMetricRuleRequest): Promise<PutGroupMetricRuleResponse>;
|
|
15638
15986
|
/**
|
|
15639
|
-
*
|
|
15640
|
-
*
|
|
15641
|
-
*
|
|
15987
|
+
* # [](#)Prerequisites
|
|
15988
|
+
* Hybrid Cloud Monitoring is activated. For more information, see [Activate Hybrid Cloud Monitoring](~~250773~~).
|
|
15989
|
+
* # [](#)Limits
|
|
15990
|
+
* The size of the monitoring data that you import at a time must be less than or equal to 1 MB.
|
|
15991
|
+
* # [](#)Description
|
|
15992
|
+
* This topic provides an example on how to import the monitoring data of the `CPU_Usage` metric to the `default-aliyun` namespace of Hybrid Cloud Monitoring.
|
|
15642
15993
|
*
|
|
15643
15994
|
* @param request PutHybridMonitorMetricDataRequest
|
|
15644
15995
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -15646,9 +15997,12 @@ export default class Client extends OpenApi {
|
|
|
15646
15997
|
*/
|
|
15647
15998
|
putHybridMonitorMetricDataWithOptions(request: PutHybridMonitorMetricDataRequest, runtime: $Util.RuntimeOptions): Promise<PutHybridMonitorMetricDataResponse>;
|
|
15648
15999
|
/**
|
|
15649
|
-
*
|
|
15650
|
-
*
|
|
15651
|
-
*
|
|
16000
|
+
* # [](#)Prerequisites
|
|
16001
|
+
* Hybrid Cloud Monitoring is activated. For more information, see [Activate Hybrid Cloud Monitoring](~~250773~~).
|
|
16002
|
+
* # [](#)Limits
|
|
16003
|
+
* The size of the monitoring data that you import at a time must be less than or equal to 1 MB.
|
|
16004
|
+
* # [](#)Description
|
|
16005
|
+
* This topic provides an example on how to import the monitoring data of the `CPU_Usage` metric to the `default-aliyun` namespace of Hybrid Cloud Monitoring.
|
|
15652
16006
|
*
|
|
15653
16007
|
* @param request PutHybridMonitorMetricDataRequest
|
|
15654
16008
|
* @return PutHybridMonitorMetricDataResponse
|
|
@@ -15693,8 +16047,7 @@ export default class Client extends OpenApi {
|
|
|
15693
16047
|
putMonitoringConfigWithOptions(request: PutMonitoringConfigRequest, runtime: $Util.RuntimeOptions): Promise<PutMonitoringConfigResponse>;
|
|
15694
16048
|
putMonitoringConfig(request: PutMonitoringConfigRequest): Promise<PutMonitoringConfigResponse>;
|
|
15695
16049
|
/**
|
|
15696
|
-
* The
|
|
15697
|
-
* > If an alert is not cleared within the mute period, a new alert notification is sent when the mute period ends.
|
|
16050
|
+
* This topic provides an example to show how to create a threshold-triggered alert rule for the `cpu_total` metric of an Elastic Compute Service (ECS) instance whose ID is `i-uf6j91r34rnwawoo****`. The namespace of ECS is `acs_ecs_dashboard`. The alert contact group of the alert rule is `ECS_Group`. The name of the alert rule is `test123`. The ID of the alert rule is `a151cd6023eacee2f0978e03863cc1697c89508****`. The statistical method for Critical-level alerts is `Average`. The comparison operator for Critical-level alerts is `GreaterThanOrEqualToThreshold`. The threshold for Critical-level alerts is `90`. The consecutive number of times for which the metric value meets the trigger condition before a Critical-level alert is triggered is `3`.
|
|
15698
16051
|
*
|
|
15699
16052
|
* @param tmpReq PutResourceMetricRuleRequest
|
|
15700
16053
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -15702,8 +16055,7 @@ export default class Client extends OpenApi {
|
|
|
15702
16055
|
*/
|
|
15703
16056
|
putResourceMetricRuleWithOptions(tmpReq: PutResourceMetricRuleRequest, runtime: $Util.RuntimeOptions): Promise<PutResourceMetricRuleResponse>;
|
|
15704
16057
|
/**
|
|
15705
|
-
* The
|
|
15706
|
-
* > If an alert is not cleared within the mute period, a new alert notification is sent when the mute period ends.
|
|
16058
|
+
* This topic provides an example to show how to create a threshold-triggered alert rule for the `cpu_total` metric of an Elastic Compute Service (ECS) instance whose ID is `i-uf6j91r34rnwawoo****`. The namespace of ECS is `acs_ecs_dashboard`. The alert contact group of the alert rule is `ECS_Group`. The name of the alert rule is `test123`. The ID of the alert rule is `a151cd6023eacee2f0978e03863cc1697c89508****`. The statistical method for Critical-level alerts is `Average`. The comparison operator for Critical-level alerts is `GreaterThanOrEqualToThreshold`. The threshold for Critical-level alerts is `90`. The consecutive number of times for which the metric value meets the trigger condition before a Critical-level alert is triggered is `3`.
|
|
15707
16059
|
*
|
|
15708
16060
|
* @param request PutResourceMetricRuleRequest
|
|
15709
16061
|
* @return PutResourceMetricRuleResponse
|