@alicloud/cms20240330 6.0.1 → 6.2.0

package/src/models/IncidentEventStruct.ts

@@ -3,19 +3,108 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class IncidentEventStruct extends $dara.Model {
+  /**
+   * @remarks
+   * Automatic recovery time.
+   * 
+   * @example
+   * 1741234567890
+   */
   autoRecoverTime?: number;
+  /**
+   * @remarks
+   * Content.
+   * 
+   * @example
+   * Detected that the CPU usage of the user-service instance i-abc123 has reached 95%, triggering an alert.
+   */
   content?: string;
+  /**
+   * @remarks
+   * Count.
+   * 
+   * @example
+   * 6
+   */
   count?: number;
+  /**
+   * @remarks
+   * Dimension.
+   */
   dimension?: { [key: string]: string };
+  /**
+   * @remarks
+   * Used for grouping dimensions.
+   */
   groupBy?: { [key: string]: string };
+  /**
+   * @remarks
+   * Incident Event Id.
+   * 
+   * @example
+   * event-001
+   */
   incidentEventId?: string;
+  /**
+   * @remarks
+   * Incident Id.
+   * 
+   * @example
+   * incident-001
+   */
   incidentId?: string;
+  /**
+   * @remarks
+   * Last time.
+   * 
+   * @example
+   * 1741234567890
+   */
   lastTime?: number;
+  /**
+   * @remarks
+   * Manual recovery time.
+   * 
+   * @example
+   * 1741234567890
+   */
   recoverTime?: number;
+  /**
+   * @remarks
+   * Describes the resource information associated with the event.
+   */
   resource?: { [key: string]: string };
+  /**
+   * @remarks
+   * Status.
+   * 
+   * @example
+   * Running
+   */
   status?: number;
+  /**
+   * @remarks
+   * Time.
+   * 
+   * @example
+   * 2025-03-11T08:21:58Z
+   */
   time?: string;
+  /**
+   * @remarks
+   * Title.
+   * 
+   * @example
+   * User service CPU usage is too high.
+   */
   title?: string;
+  /**
+   * @remarks
+   * User ID.
+   * 
+   * @example
+   * user-12345
+   */
   userId?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/IncidentForView.ts

@@ -9,25 +9,69 @@ import { EventResourceForIncidentView } from "./EventResourceForIncidentView";
 export class IncidentForView extends $dara.Model {
   content?: string;
   escalations?: IncidentEscalationPolicyForView[];
+  /**
+   * @example
+   * "group-123456"
+   */
   groupUuid?: string;
   groupingKeys?: { [key: string]: string };
+  /**
+   * @example
+   * "incident-abc123"
+   */
   incidentId?: string;
   notifyStrategyName?: string;
+  /**
+   * @example
+   * "notify-strategy-789"
+   */
   notifyStrategyUuid?: string;
   operator?: ContactForIncidentView;
   owners?: ContactForIncidentView[];
   participants?: ContactForIncidentView[];
   plan?: IncidentResponsePlanForView;
   relatedResources?: EventResourceForIncidentView[];
+  /**
+   * @example
+   * "Network"
+   */
   rootCauseCategory?: string;
+  /**
+   * @example
+   * "Critical"
+   */
   severity?: string;
   solution?: string;
+  /**
+   * @example
+   * "Open"
+   */
   state?: string;
+  /**
+   * @example
+   * "P1-Alert-Notification"
+   */
   subscriptionName?: string;
+  /**
+   * @example
+   * "subscription-abc"
+   */
   subscriptionUuid?: string;
+  /**
+   * @example
+   * 1743876000000
+   */
   time?: number;
   title?: string;
+  /**
+   * @example
+   * "user-abc123"
+   */
   userId?: string;
+  /**
+   * @example
+   * "ws-xyz789"
+   */
   workspace?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/IncidentMemberStruct.ts

@@ -3,7 +3,21 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class IncidentMemberStructAcknowledge extends $dara.Model {
+  /**
+   * @remarks
+   * Acknowledgement level.
+   * 
+   * @example
+   * 2
+   */
   breakLevel?: string;
+  /**
+   * @remarks
+   * Verification time.
+   * 
+   * @example
+   * 1741234567890
+   */
   verifyTime?: number;
   static names(): { [key: string]: string } {
     return {
@@ -29,7 +43,21 @@ export class IncidentMemberStructAcknowledge extends $dara.Model {
 }
 
 export class IncidentMemberStructContacts extends $dara.Model {
+  /**
+   * @remarks
+   * Channel.
+   * 
+   * @example
+   * dingtalk
+   */
   channel?: string;
+  /**
+   * @remarks
+   * Contact ID (masked).
+   * 
+   * @example
+   * user-12345
+   */
   contactMask?: string;
   static names(): { [key: string]: string } {
     return {
@@ -55,10 +83,45 @@ export class IncidentMemberStructContacts extends $dara.Model {
 }
 
 export class IncidentMemberStructEscalation extends $dara.Model {
+  /**
+   * @remarks
+   * Description.
+   * 
+   * @example
+   * Notify the operations team.
+   */
   description?: string;
+  /**
+   * @remarks
+   * Event Escalation ID.
+   * 
+   * @example
+   * escalation-001
+   */
   incidentEscalationId?: string;
+  /**
+   * @remarks
+   * Name.
+   * 
+   * @example
+   * Phase one.
+   */
   name?: string;
+  /**
+   * @remarks
+   * Escalation phase index.
+   * 
+   * @example
+   * 1
+   */
   stageIndex?: string;
+  /**
+   * @remarks
+   * Title.
+   * 
+   * @example
+   * Alert escalated to the operations team.
+   */
   title?: string;
   static names(): { [key: string]: string } {
     return {
@@ -90,7 +153,21 @@ export class IncidentMemberStructEscalation extends $dara.Model {
 }
 
 export class IncidentMemberStructScheduleGroup extends $dara.Model {
+  /**
+   * @remarks
+   * Contact ID.
+   * 
+   * @example
+   * group-001
+   */
   contactId?: string;
+  /**
+   * @remarks
+   * Name.
+   * 
+   * @example
+   * Night shift duty team.
+   */
   name?: string;
   static names(): { [key: string]: string } {
     return {
@@ -116,14 +193,65 @@ export class IncidentMemberStructScheduleGroup extends $dara.Model {
 }
 
 export class IncidentMemberStruct extends $dara.Model {
+  /**
+   * @remarks
+   * Acknowledgement Information Structure.
+   */
   acknowledge?: IncidentMemberStructAcknowledge;
+  /**
+   * @remarks
+   * Contact ID.
+   * 
+   * @example
+   * user-12345
+   */
   contactId?: string;
+  /**
+   * @remarks
+   * Contact list.
+   */
   contacts?: IncidentMemberStructContacts[];
+  /**
+   * @remarks
+   * Escalation phase information.
+   */
   escalation?: IncidentMemberStructEscalation;
+  /**
+   * @remarks
+   * Incident ID.
+   * 
+   * @example
+   * incident-001
+   */
   incidentId?: string;
+  /**
+   * @remarks
+   * Event Member ID.
+   * 
+   * @example
+   * member-001
+   */
   incidentMemberId?: string;
+  /**
+   * @remarks
+   * Schedule group.
+   */
   scheduleGroup?: IncidentMemberStructScheduleGroup;
+  /**
+   * @remarks
+   * Time.
+   * 
+   * @example
+   * 2025-10-08 10:18:58
+   */
   time?: number;
+  /**
+   * @remarks
+   * User ID.
+   * 
+   * @example
+   * 4123456
+   */
   userId?: number;
   static names(): { [key: string]: string } {
     return {

package/src/models/IncidentNoteStruct.ts

@@ -3,9 +3,37 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class IncidentNoteStructOperator extends $dara.Model {
+  /**
+   * @remarks
+   * Contact.
+   * 
+   * @example
+   * {\\"mobile_phone_num\\":\\"153xxxx8040\\",\\"mobile_country_code\\":\\"86\\",\\"email\\":\\"flightxxg@dida.com\\"}
+   */
   contact?: string;
+  /**
+   * @remarks
+   * Contact ID.
+   * 
+   * @example
+   * user-12345
+   */
   contactId?: string;
+  /**
+   * @remarks
+   * Name.
+   * 
+   * @example
+   * Zhang San.
+   */
   name?: string;
+  /**
+   * @remarks
+   * User ID.
+   * 
+   * @example
+   * 4123456
+   */
   userId?: number;
   static names(): { [key: string]: string } {
     return {
@@ -35,12 +63,58 @@ export class IncidentNoteStructOperator extends $dara.Model {
 }
 
 export class IncidentNoteStruct extends $dara.Model {
+  /**
+   * @remarks
+   * Content.
+   * 
+   * @example
+   * The operations team has been contacted and is currently investigating the issue.
+   */
   content?: string;
+  /**
+   * @remarks
+   * Content format.
+   * 
+   * @example
+   * markdown
+   */
   format?: string;
+  /**
+   * @remarks
+   * Incident ID.
+   * 
+   * @example
+   * incident-001
+   */
   incidentId?: string;
+  /**
+   * @remarks
+   * Note ID.
+   * 
+   * @example
+   * note-001
+   */
   noteId?: string;
+  /**
+   * @remarks
+   * Operator.
+   */
   operator?: IncidentNoteStructOperator;
+  /**
+   * @remarks
+   * Time.
+   * 
+   * @example
+   * 1741234567890
+   */
   time?: number;
+  /**
+   * @remarks
+   * Type.
+   * 
+   * @example
+   * apm
+   */
   type?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/IncidentPlanCorporationStruct.ts

@@ -3,7 +3,21 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class IncidentPlanCorporationStruct extends $dara.Model {
+  /**
+   * @remarks
+   * Channel name.
+   * 
+   * @example
+   * ecs
+   */
   channel?: string;
+  /**
+   * @remarks
+   * Robot ID.
+   * 
+   * @example
+   * robotId-cs-api-test
+   */
   robotId?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/IncidentPlanFieldPath.ts

@@ -3,7 +3,18 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class IncidentPlanFieldPath extends $dara.Model {
+  /**
+   * @remarks
+   * Field alias.
+   * 
+   * @example
+   * Service name.
+   */
   fieldAlias?: string;
+  /**
+   * @remarks
+   * List of field paths.
+   */
   fieldPath?: string[];
   static names(): { [key: string]: string } {
     return {

package/src/models/IncidentPlanStruct.ts

@@ -5,19 +5,105 @@ import { IncidentPlanFieldPath } from "./IncidentPlanFieldPath";
 
 
 export class IncidentPlanStruct extends $dara.Model {
+  /**
+   * @remarks
+   * Automatic recovery wait time.
+   * 
+   * @example
+   * 3600
+   */
   autoRecoverSeconds?: number;
+  /**
+   * @remarks
+   * Event closure timeout.
+   * 
+   * @example
+   * 86400000
+   */
   closeExpire?: number;
+  /**
+   * @remarks
+   * List of teams or roles involved in collaboration.
+   */
   corporation?: IncidentPlanCorporationStruct[];
+  /**
+   * @remarks
+   * Contingency plan description.
+   * 
+   * @example
+   * Emergency response plan for excessively high database connection count.
+   */
   description?: string;
+  /**
+   * @remarks
+   * List of escalation policy IDs.
+   */
   escalationId?: string[];
+  /**
+   * @remarks
+   * Creation time.
+   * 
+   * @example
+   * 1741234567890
+   */
   gmtCreate?: number;
+  /**
+   * @remarks
+   * Last modification time.
+   * 
+   * @example
+   * 1741234567890
+   */
   gmtModified?: number;
+  /**
+   * @remarks
+   * Grouping field path.
+   */
   groupBy?: IncidentPlanFieldPath[];
+  /**
+   * @remarks
+   * Event contingency plan ID.
+   * 
+   * @example
+   * plan-001
+   */
   incidentPlanId?: string;
+  /**
+   * @remarks
+   * Contingency plan name.
+   * 
+   * @example
+   * Database connection count alert contingency plan.
+   */
   name?: string;
+  /**
+   * @remarks
+   * List of resource field mapping paths.
+   */
   resourceFiled?: IncidentPlanFieldPath[];
+  /**
+   * @remarks
+   * Status.
+   * 
+   * @example
+   * Running
+   */
   status?: string;
+  /**
+   * @remarks
+   * User ID.
+   * 
+   * @example
+   * uesr-12345
+   */
   userId?: number;
+  /**
+   * @remarks
+   * Workspace name.
+   * 
+   * @example
+   * workspace-test
+   */
   workspace?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/IncidentResourceDetail.ts

@@ -3,8 +3,29 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class IncidentResourceDetail extends $dara.Model {
+  /**
+   * @remarks
+   * Additional resource identifier.
+   * 
+   * @example
+   * app-prod-web-01
+   */
   extraId?: string;
+  /**
+   * @remarks
+   * Resource ID object.
+   * 
+   * @example
+   * { "type": "ecs", "id": "i-bp1234567890abcdef" }
+   */
   resourceId?: { [key: string]: any };
+  /**
+   * @remarks
+   * Resource type, indicating which cloud product the resource belongs to.
+   * 
+   * @example
+   * ecs
+   */
   type?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/IncidentResourceStruct.ts

@@ -4,12 +4,58 @@ import { IncidentResourceDetail } from "./IncidentResourceDetail";
 
 
 export class IncidentResourceStruct extends $dara.Model {
+  /**
+   * @remarks
+   * Description information.
+   * 
+   * @example
+   * Production environment web server.
+   */
   description?: string;
+  /**
+   * @remarks
+   * Incident ID.
+   * 
+   * @example
+   * incident-001
+   */
   incidentId?: string;
+  /**
+   * @remarks
+   * The unique ID of this resource in the event.
+   * 
+   * @example
+   * res-001
+   */
   incidentResourceId?: string;
+  /**
+   * @remarks
+   * Event resource details object.
+   */
   resource?: IncidentResourceDetail;
+  /**
+   * @remarks
+   * Source.
+   * 
+   * @example
+   * cloudmonitor
+   */
   source?: string;
+  /**
+   * @remarks
+   * Time.
+   * 
+   * @example
+   * 1741234567890
+   */
   time?: number;
+  /**
+   * @remarks
+   * User ID.
+   * 
+   * @example
+   * user-12345
+   */
   userId?: number;
   static names(): { [key: string]: string } {
     return {