@alicloud/bdrc20230808 1.0.0 → 2.0.0

package/src/models/DescribeResourcesRequest.ts

@@ -0,0 +1,157 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeResourcesRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The data redundancy type.
+   * 
+   * @example
+   * LRS
+   */
+  dataRedundancyType?: string;
+  /**
+   * @remarks
+   * A filter for rules that failed the scoring.
+   * 
+   * @example
+   * rule-000c***yc9
+   */
+  failedRuleTemplate?: string;
+  /**
+   * @remarks
+   * The page size. Default: 10. Maximum: 100. Values less than 10 are set to 10, and values greater than 100 are set to 100.
+   * 
+   * @example
+   * 10
+   */
+  maxResults?: number;
+  /**
+   * @remarks
+   * The pagination token. The service returns a token if the response is truncated. To retrieve the next page of results, include this token in your next request. If no token is returned, all results have been retrieved.
+   * 
+   * @example
+   * cae**********699
+   */
+  nextToken?: string;
+  /**
+   * @remarks
+   * The Resource ARN.
+   * 
+   * @example
+   * acs:ecs:cn-hangzhou:123***7890:instance/i-123***7890
+   */
+  resourceArn?: string;
+  /**
+   * @remarks
+   * The ID of the resource category.
+   * 
+   * @example
+   * rc-000***123
+   */
+  resourceCategoryId?: string;
+  /**
+   * @remarks
+   * The resource ID. For example, for an instance, this is the instance ID.
+   * 
+   * @example
+   * i-0003***110
+   */
+  resourceId?: string;
+  /**
+   * @remarks
+   * A list of resource owner IDs. Use this parameter for cross-account scenarios. If you omit this parameter, the service returns data for the current account by default.
+   * 
+   * @example
+   * [123***7890]
+   */
+  resourceOwnerIds?: number[];
+  /**
+   * @remarks
+   * The resource region ID.
+   * 
+   * @example
+   * cn-hangzhou
+   */
+  resourceRegionId?: string;
+  /**
+   * @remarks
+   * The resource type.
+   * 
+   * @example
+   * ACS::ECS::Instance
+   */
+  resourceType?: string;
+  /**
+   * @remarks
+   * The sort key.
+   * 
+   * @example
+   * protectionScore
+   */
+  sortBy?: string;
+  /**
+   * @remarks
+   * The sort order.
+   * 
+   * @example
+   * ASC
+   */
+  sortOrder?: string;
+  /**
+   * @remarks
+   * The storage class.
+   * 
+   * @example
+   * ARCHIVE
+   */
+  storageClass?: string;
+  static names(): { [key: string]: string } {
+    return {
+      dataRedundancyType: 'DataRedundancyType',
+      failedRuleTemplate: 'FailedRuleTemplate',
+      maxResults: 'MaxResults',
+      nextToken: 'NextToken',
+      resourceArn: 'ResourceArn',
+      resourceCategoryId: 'ResourceCategoryId',
+      resourceId: 'ResourceId',
+      resourceOwnerIds: 'ResourceOwnerIds',
+      resourceRegionId: 'ResourceRegionId',
+      resourceType: 'ResourceType',
+      sortBy: 'SortBy',
+      sortOrder: 'SortOrder',
+      storageClass: 'StorageClass',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      dataRedundancyType: 'string',
+      failedRuleTemplate: 'string',
+      maxResults: 'number',
+      nextToken: 'string',
+      resourceArn: 'string',
+      resourceCategoryId: 'string',
+      resourceId: 'string',
+      resourceOwnerIds: { 'type': 'array', 'itemType': 'number' },
+      resourceRegionId: 'string',
+      resourceType: 'string',
+      sortBy: 'string',
+      sortOrder: 'string',
+      storageClass: 'string',
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.resourceOwnerIds)) {
+      $dara.Model.validateArray(this.resourceOwnerIds);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeResourcesResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { DescribeResourcesResponseBody } from "./DescribeResourcesResponseBody";
+
+
+export class DescribeResourcesResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: DescribeResourcesResponseBody;
+  static names(): { [key: string]: string } {
+    return {
+      headers: 'headers',
+      statusCode: 'statusCode',
+      body: 'body',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
+      statusCode: 'number',
+      body: DescribeResourcesResponseBody,
+    };
+  }
+
+  validate() {
+    if(this.headers) {
+      $dara.Model.validateMap(this.headers);
+    }
+    if(this.body && typeof (this.body as any).validate === 'function') {
+      (this.body as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeResourcesResponseBody.ts

@@ -0,0 +1,364 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeResourcesResponseBodyDataContent extends $dara.Model {
+  /**
+   * @remarks
+   * The amount of data in the Archive storage class.
+   * 
+   * @example
+   * 0
+   */
+  archiveDataSize?: number;
+  /**
+   * @remarks
+   * The number of failed check items.
+   * 
+   * @example
+   * 0
+   */
+  checkFailedCount?: number;
+  /**
+   * @remarks
+   * The amount of data in the Cold Archive storage class.
+   * 
+   * @example
+   * 0
+   */
+  coldArchiveDataSize?: number;
+  /**
+   * @remarks
+   * The UNIX timestamp that indicates when the resource was created.
+   * 
+   * @example
+   * 1697798340
+   */
+  createTime?: number;
+  /**
+   * @remarks
+   * The data redundancy type.
+   * 
+   * @example
+   * LRS
+   */
+  dataRedundancyType?: string;
+  /**
+   * @remarks
+   * Indicates whether data protection scoring is enabled for the resource.
+   * 
+   * @example
+   * 0
+   */
+  enableCheck?: boolean;
+  /**
+   * @remarks
+   * The amount of data in the Infrequent Access (IA) storage class.
+   * 
+   * @example
+   * 0
+   */
+  iaDataSize?: number;
+  /**
+   * @remarks
+   * The type of the cloud service.
+   * 
+   * @example
+   * ecs
+   */
+  productType?: string;
+  /**
+   * @remarks
+   * The data protection score of the resource.
+   * 
+   * @example
+   * 0
+   */
+  protectionScore?: number;
+  /**
+   * @remarks
+   * The UNIX timestamp that indicates when the score was last updated.
+   * 
+   * @example
+   * 0
+   */
+  protectionScoreUpdatedTime?: number;
+  /**
+   * @remarks
+   * The region ID.
+   * 
+   * @example
+   * cn-hangzhou
+   */
+  regionId?: string;
+  /**
+   * @remarks
+   * The unique resource ARN.
+   * 
+   * @example
+   * acs:ecs:cn-hangzhou:xxxxxxxx:instance/xxxxx
+   */
+  resourceArn?: string;
+  /**
+   * @remarks
+   * The resource ID.
+   * 
+   * @example
+   * i-xxxxxxxx
+   */
+  resourceId?: string;
+  /**
+   * @remarks
+   * The name of the resource.
+   * 
+   * @example
+   * test server
+   */
+  resourceName?: string;
+  /**
+   * @remarks
+   * The resource owner ID.
+   * 
+   * @example
+   * 123***7890
+   */
+  resourceOwnerId?: number;
+  /**
+   * @remarks
+   * The resource type.
+   * 
+   * @example
+   * ACS::ECS::Instance
+   */
+  resourceType?: string;
+  /**
+   * @remarks
+   * The number of check items with potential risks.
+   * 
+   * @example
+   * 0
+   */
+  riskCount?: number;
+  /**
+   * @remarks
+   * The amount of data in the Standard storage class.
+   * 
+   * @example
+   * 0
+   */
+  standardDataSize?: number;
+  /**
+   * @remarks
+   * The resource status.
+   * 
+   * @example
+   * Running
+   */
+  status?: string;
+  /**
+   * @remarks
+   * The storage class of the resource.
+   * 
+   * @example
+   * STANDARD
+   */
+  storageClass?: string;
+  /**
+   * @remarks
+   * The total amount of data.
+   * 
+   * @example
+   * 0
+   */
+  totalDataSize?: number;
+  /**
+   * @remarks
+   * The vSwitch ID.
+   * 
+   * @example
+   * vsw-xxxxxxxx
+   */
+  vSwitchId?: string;
+  /**
+   * @remarks
+   * The VPC ID.
+   * 
+   * @example
+   * vpc-xxxxxxxx
+   */
+  vpcId?: string;
+  /**
+   * @remarks
+   * The zone ID.
+   * 
+   * @example
+   * cn-hangzhou-i
+   */
+  zoneId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      archiveDataSize: 'ArchiveDataSize',
+      checkFailedCount: 'CheckFailedCount',
+      coldArchiveDataSize: 'ColdArchiveDataSize',
+      createTime: 'CreateTime',
+      dataRedundancyType: 'DataRedundancyType',
+      enableCheck: 'EnableCheck',
+      iaDataSize: 'IaDataSize',
+      productType: 'ProductType',
+      protectionScore: 'ProtectionScore',
+      protectionScoreUpdatedTime: 'ProtectionScoreUpdatedTime',
+      regionId: 'RegionId',
+      resourceArn: 'ResourceArn',
+      resourceId: 'ResourceId',
+      resourceName: 'ResourceName',
+      resourceOwnerId: 'ResourceOwnerId',
+      resourceType: 'ResourceType',
+      riskCount: 'RiskCount',
+      standardDataSize: 'StandardDataSize',
+      status: 'Status',
+      storageClass: 'StorageClass',
+      totalDataSize: 'TotalDataSize',
+      vSwitchId: 'VSwitchId',
+      vpcId: 'VpcId',
+      zoneId: 'ZoneId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      archiveDataSize: 'number',
+      checkFailedCount: 'number',
+      coldArchiveDataSize: 'number',
+      createTime: 'number',
+      dataRedundancyType: 'string',
+      enableCheck: 'boolean',
+      iaDataSize: 'number',
+      productType: 'string',
+      protectionScore: 'number',
+      protectionScoreUpdatedTime: 'number',
+      regionId: 'string',
+      resourceArn: 'string',
+      resourceId: 'string',
+      resourceName: 'string',
+      resourceOwnerId: 'number',
+      resourceType: 'string',
+      riskCount: 'number',
+      standardDataSize: 'number',
+      status: 'string',
+      storageClass: 'string',
+      totalDataSize: 'number',
+      vSwitchId: 'string',
+      vpcId: 'string',
+      zoneId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class DescribeResourcesResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * The list of returned resources.
+   */
+  content?: DescribeResourcesResponseBodyDataContent[];
+  /**
+   * @remarks
+   * The maximum number of resources to return on each page.
+   * 
+   * @example
+   * 100
+   */
+  maxResults?: number;
+  /**
+   * @remarks
+   * The pagination token to retrieve the next page of results. If this parameter is empty, all results have been returned.
+   * 
+   * @example
+   * fb836242f4225fa0f0e0257362dfc6dd
+   */
+  nextToken?: string;
+  /**
+   * @remarks
+   * The total number of resources that match the query criteria. This parameter is optional and is not returned by default.
+   * 
+   * @example
+   * 149
+   */
+  totalCount?: number;
+  static names(): { [key: string]: string } {
+    return {
+      content: 'Content',
+      maxResults: 'MaxResults',
+      nextToken: 'NextToken',
+      totalCount: 'TotalCount',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      content: { 'type': 'array', 'itemType': DescribeResourcesResponseBodyDataContent },
+      maxResults: 'number',
+      nextToken: 'string',
+      totalCount: 'number',
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.content)) {
+      $dara.Model.validateArray(this.content);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class DescribeResourcesResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The response data.
+   */
+  data?: DescribeResourcesResponseBodyData;
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * 700683DE-0154-56D4-8D76-3B7A2C2C7DF9
+   */
+  requestId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      data: 'Data',
+      requestId: 'RequestId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      data: DescribeResourcesResponseBodyData,
+      requestId: 'string',
+    };
+  }
+
+  validate() {
+    if(this.data && typeof (this.data as any).validate === 'function') {
+      (this.data as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeResourcesShrinkRequest.ts

@@ -0,0 +1,154 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeResourcesShrinkRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The data redundancy type.
+   * 
+   * @example
+   * LRS
+   */
+  dataRedundancyType?: string;
+  /**
+   * @remarks
+   * A filter for rules that failed the scoring.
+   * 
+   * @example
+   * rule-000c***yc9
+   */
+  failedRuleTemplate?: string;
+  /**
+   * @remarks
+   * The page size. Default: 10. Maximum: 100. Values less than 10 are set to 10, and values greater than 100 are set to 100.
+   * 
+   * @example
+   * 10
+   */
+  maxResults?: number;
+  /**
+   * @remarks
+   * The pagination token. The service returns a token if the response is truncated. To retrieve the next page of results, include this token in your next request. If no token is returned, all results have been retrieved.
+   * 
+   * @example
+   * cae**********699
+   */
+  nextToken?: string;
+  /**
+   * @remarks
+   * The Resource ARN.
+   * 
+   * @example
+   * acs:ecs:cn-hangzhou:123***7890:instance/i-123***7890
+   */
+  resourceArn?: string;
+  /**
+   * @remarks
+   * The ID of the resource category.
+   * 
+   * @example
+   * rc-000***123
+   */
+  resourceCategoryId?: string;
+  /**
+   * @remarks
+   * The resource ID. For example, for an instance, this is the instance ID.
+   * 
+   * @example
+   * i-0003***110
+   */
+  resourceId?: string;
+  /**
+   * @remarks
+   * A list of resource owner IDs. Use this parameter for cross-account scenarios. If you omit this parameter, the service returns data for the current account by default.
+   * 
+   * @example
+   * [123***7890]
+   */
+  resourceOwnerIdsShrink?: string;
+  /**
+   * @remarks
+   * The resource region ID.
+   * 
+   * @example
+   * cn-hangzhou
+   */
+  resourceRegionId?: string;
+  /**
+   * @remarks
+   * The resource type.
+   * 
+   * @example
+   * ACS::ECS::Instance
+   */
+  resourceType?: string;
+  /**
+   * @remarks
+   * The sort key.
+   * 
+   * @example
+   * protectionScore
+   */
+  sortBy?: string;
+  /**
+   * @remarks
+   * The sort order.
+   * 
+   * @example
+   * ASC
+   */
+  sortOrder?: string;
+  /**
+   * @remarks
+   * The storage class.
+   * 
+   * @example
+   * ARCHIVE
+   */
+  storageClass?: string;
+  static names(): { [key: string]: string } {
+    return {
+      dataRedundancyType: 'DataRedundancyType',
+      failedRuleTemplate: 'FailedRuleTemplate',
+      maxResults: 'MaxResults',
+      nextToken: 'NextToken',
+      resourceArn: 'ResourceArn',
+      resourceCategoryId: 'ResourceCategoryId',
+      resourceId: 'ResourceId',
+      resourceOwnerIdsShrink: 'ResourceOwnerIds',
+      resourceRegionId: 'ResourceRegionId',
+      resourceType: 'ResourceType',
+      sortBy: 'SortBy',
+      sortOrder: 'SortOrder',
+      storageClass: 'StorageClass',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      dataRedundancyType: 'string',
+      failedRuleTemplate: 'string',
+      maxResults: 'number',
+      nextToken: 'string',
+      resourceArn: 'string',
+      resourceCategoryId: 'string',
+      resourceId: 'string',
+      resourceOwnerIdsShrink: 'string',
+      resourceRegionId: 'string',
+      resourceType: 'string',
+      sortBy: 'string',
+      sortOrder: 'string',
+      storageClass: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+