@alicloud/polardb20170801 7.3.0 → 7.5.0

package/src/models/DescribePolarFsRequest.ts

@@ -0,0 +1,162 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribePolarFsRequestTag extends $dara.Model {
+  /**
+   * @remarks
+   * The tag key.
+   * 
+   * @example
+   * testKey
+   */
+  key?: string;
+  /**
+   * @remarks
+   * The tag value.
+   * 
+   * @example
+   * testValue
+   */
+  value?: string;
+  static names(): { [key: string]: string } {
+    return {
+      key: 'Key',
+      value: 'Value',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      key: 'string',
+      value: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class DescribePolarFsRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The instance ID of the PolarDB instance on which the application depends.
+   * 
+   * @example
+   * pc-2ze8u21s03******
+   */
+  DBClusterId?: string;
+  /**
+   * @remarks
+   * The page number. The value must be an integer greater than 0 and not exceeding the maximum value of Integer.
+   * 
+   * @example
+   * 1
+   */
+  pageNumber?: number;
+  /**
+   * @remarks
+   * The number of entries per page. Valid values:
+   * 
+   * - **30**
+   * 
+   * - **50**
+   * 
+   * - **100**
+   * 
+   * @example
+   * 30
+   */
+  pageSize?: number;
+  /**
+   * @remarks
+   * The description of the PolarFS instance.
+   * 
+   * @example
+   * pfs-ins1********
+   */
+  polarFsInstanceDescription?: string;
+  /**
+   * @remarks
+   * The list of PolarFS instance IDs, separated by commas (,).
+   * 
+   * @example
+   * pfs-ins1*******
+   */
+  polarFsInstanceIds?: string;
+  /**
+   * @remarks
+   * The PolarFS type.
+   * 
+   * @example
+   * all
+   */
+  polarFsType?: string;
+  /**
+   * @remarks
+   * The region ID.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * cn-beijing
+   */
+  regionId?: string;
+  /**
+   * @remarks
+   * The ID of the associated PolarDB cluster.
+   * 
+   * @example
+   * pc-2zejpr41d9xk*****
+   */
+  relativeDbClusterId?: string;
+  /**
+   * @remarks
+   * The tags.
+   */
+  tag?: DescribePolarFsRequestTag[];
+  static names(): { [key: string]: string } {
+    return {
+      DBClusterId: 'DBClusterId',
+      pageNumber: 'PageNumber',
+      pageSize: 'PageSize',
+      polarFsInstanceDescription: 'PolarFsInstanceDescription',
+      polarFsInstanceIds: 'PolarFsInstanceIds',
+      polarFsType: 'PolarFsType',
+      regionId: 'RegionId',
+      relativeDbClusterId: 'RelativeDbClusterId',
+      tag: 'Tag',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      DBClusterId: 'string',
+      pageNumber: 'number',
+      pageSize: 'number',
+      polarFsInstanceDescription: 'string',
+      polarFsInstanceIds: 'string',
+      polarFsType: 'string',
+      regionId: 'string',
+      relativeDbClusterId: 'string',
+      tag: { 'type': 'array', 'itemType': DescribePolarFsRequestTag },
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.tag)) {
+      $dara.Model.validateArray(this.tag);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribePolarFsResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { DescribePolarFsResponseBody } from "./DescribePolarFsResponseBody";
+
+
+export class DescribePolarFsResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: DescribePolarFsResponseBody;
+  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: DescribePolarFsResponseBody,
+    };
+  }
+
+  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/DescribePolarFsResponseBody.ts

@@ -0,0 +1,347 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribePolarFsResponseBodyItemsPolarFsPathsMountInfo extends $dara.Model {
+  polarDbProxy?: string;
+  polarFsCluster?: string;
+  token?: string;
+  static names(): { [key: string]: string } {
+    return {
+      polarDbProxy: 'PolarDbProxy',
+      polarFsCluster: 'PolarFsCluster',
+      token: 'Token',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      polarDbProxy: 'string',
+      polarFsCluster: 'string',
+      token: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class DescribePolarFsResponseBodyItemsPolarFsPathsMountedAIDBClustersMountedAIDBClusters extends $dara.Model {
+  DBClusterId?: string;
+  mountDir?: string;
+  mountStatus?: string;
+  mountedTime?: string;
+  static names(): { [key: string]: string } {
+    return {
+      DBClusterId: 'DBClusterId',
+      mountDir: 'MountDir',
+      mountStatus: 'MountStatus',
+      mountedTime: 'MountedTime',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      DBClusterId: 'string',
+      mountDir: 'string',
+      mountStatus: 'string',
+      mountedTime: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class DescribePolarFsResponseBodyItemsPolarFsPathsMountedAIDBClusters extends $dara.Model {
+  mountedAIDBClusters?: DescribePolarFsResponseBodyItemsPolarFsPathsMountedAIDBClustersMountedAIDBClusters[];
+  static names(): { [key: string]: string } {
+    return {
+      mountedAIDBClusters: 'MountedAIDBClusters',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      mountedAIDBClusters: { 'type': 'array', 'itemType': DescribePolarFsResponseBodyItemsPolarFsPathsMountedAIDBClustersMountedAIDBClusters },
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.mountedAIDBClusters)) {
+      $dara.Model.validateArray(this.mountedAIDBClusters);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class DescribePolarFsResponseBodyItemsPolarFsPathsTagsTag extends $dara.Model {
+  /**
+   * @example
+   * testKey
+   */
+  key?: string;
+  /**
+   * @example
+   * testValue
+   */
+  value?: string;
+  static names(): { [key: string]: string } {
+    return {
+      key: 'Key',
+      value: 'Value',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      key: 'string',
+      value: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class DescribePolarFsResponseBodyItemsPolarFsPathsTags extends $dara.Model {
+  tag?: DescribePolarFsResponseBodyItemsPolarFsPathsTagsTag[];
+  static names(): { [key: string]: string } {
+    return {
+      tag: 'Tag',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      tag: { 'type': 'array', 'itemType': DescribePolarFsResponseBodyItemsPolarFsPathsTagsTag },
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.tag)) {
+      $dara.Model.validateArray(this.tag);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class DescribePolarFsResponseBodyItemsPolarFsPaths extends $dara.Model {
+  accelerateType?: string;
+  acceleratedStorageSpace?: string;
+  acceleratingEnable?: string;
+  bandwidth?: number;
+  category?: string;
+  createTime?: string;
+  expireTime?: string;
+  expired?: string;
+  mountInfo?: DescribePolarFsResponseBodyItemsPolarFsPathsMountInfo;
+  mountedAIDBClusters?: DescribePolarFsResponseBodyItemsPolarFsPathsMountedAIDBClusters;
+  payType?: string;
+  polarFsInstanceDescription?: string;
+  polarFsInstanceId?: string;
+  polarFsPath?: string;
+  polarFsStatus?: string;
+  polarFsType?: string;
+  regionId?: string;
+  relativeDbClusterId?: string;
+  securityGroupId?: string;
+  storageSpace?: number;
+  storageType?: string;
+  tags?: DescribePolarFsResponseBodyItemsPolarFsPathsTags;
+  VPCId?: string;
+  vSwitchId?: string;
+  zoneId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      accelerateType: 'AccelerateType',
+      acceleratedStorageSpace: 'AcceleratedStorageSpace',
+      acceleratingEnable: 'AcceleratingEnable',
+      bandwidth: 'Bandwidth',
+      category: 'Category',
+      createTime: 'CreateTime',
+      expireTime: 'ExpireTime',
+      expired: 'Expired',
+      mountInfo: 'MountInfo',
+      mountedAIDBClusters: 'MountedAIDBClusters',
+      payType: 'PayType',
+      polarFsInstanceDescription: 'PolarFsInstanceDescription',
+      polarFsInstanceId: 'PolarFsInstanceId',
+      polarFsPath: 'PolarFsPath',
+      polarFsStatus: 'PolarFsStatus',
+      polarFsType: 'PolarFsType',
+      regionId: 'RegionId',
+      relativeDbClusterId: 'RelativeDbClusterId',
+      securityGroupId: 'SecurityGroupId',
+      storageSpace: 'StorageSpace',
+      storageType: 'StorageType',
+      tags: 'Tags',
+      VPCId: 'VPCId',
+      vSwitchId: 'VSwitchId',
+      zoneId: 'ZoneId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      accelerateType: 'string',
+      acceleratedStorageSpace: 'string',
+      acceleratingEnable: 'string',
+      bandwidth: 'number',
+      category: 'string',
+      createTime: 'string',
+      expireTime: 'string',
+      expired: 'string',
+      mountInfo: DescribePolarFsResponseBodyItemsPolarFsPathsMountInfo,
+      mountedAIDBClusters: DescribePolarFsResponseBodyItemsPolarFsPathsMountedAIDBClusters,
+      payType: 'string',
+      polarFsInstanceDescription: 'string',
+      polarFsInstanceId: 'string',
+      polarFsPath: 'string',
+      polarFsStatus: 'string',
+      polarFsType: 'string',
+      regionId: 'string',
+      relativeDbClusterId: 'string',
+      securityGroupId: 'string',
+      storageSpace: 'number',
+      storageType: 'string',
+      tags: DescribePolarFsResponseBodyItemsPolarFsPathsTags,
+      VPCId: 'string',
+      vSwitchId: 'string',
+      zoneId: 'string',
+    };
+  }
+
+  validate() {
+    if(this.mountInfo && typeof (this.mountInfo as any).validate === 'function') {
+      (this.mountInfo as any).validate();
+    }
+    if(this.mountedAIDBClusters && typeof (this.mountedAIDBClusters as any).validate === 'function') {
+      (this.mountedAIDBClusters as any).validate();
+    }
+    if(this.tags && typeof (this.tags as any).validate === 'function') {
+      (this.tags as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class DescribePolarFsResponseBodyItems extends $dara.Model {
+  polarFsPaths?: DescribePolarFsResponseBodyItemsPolarFsPaths[];
+  static names(): { [key: string]: string } {
+    return {
+      polarFsPaths: 'PolarFsPaths',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      polarFsPaths: { 'type': 'array', 'itemType': DescribePolarFsResponseBodyItemsPolarFsPaths },
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.polarFsPaths)) {
+      $dara.Model.validateArray(this.polarFsPaths);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class DescribePolarFsResponseBody extends $dara.Model {
+  items?: DescribePolarFsResponseBodyItems;
+  /**
+   * @remarks
+   * The page number.
+   * 
+   * @example
+   * 1
+   */
+  pageNumber?: number;
+  /**
+   * @remarks
+   * The number of records on the current page.
+   * 
+   * @example
+   * 13
+   */
+  pageRecordCount?: number;
+  /**
+   * @remarks
+   * Id of the request
+   * 
+   * @example
+   * 8CD1852F-8176-55E4-891C-4478DC00CC7A
+   */
+  requestId?: string;
+  /**
+   * @remarks
+   * The total number of records.
+   * 
+   * @example
+   * 16
+   */
+  totalRecordCount?: number;
+  static names(): { [key: string]: string } {
+    return {
+      items: 'Items',
+      pageNumber: 'PageNumber',
+      pageRecordCount: 'PageRecordCount',
+      requestId: 'RequestId',
+      totalRecordCount: 'TotalRecordCount',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      items: DescribePolarFsResponseBodyItems,
+      pageNumber: 'number',
+      pageRecordCount: 'number',
+      requestId: 'string',
+      totalRecordCount: 'number',
+    };
+  }
+
+  validate() {
+    if(this.items && typeof (this.items as any).validate === 'function') {
+      (this.items as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/ModifyDbclusterAccessWhitelistRequest.ts

@@ -5,11 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyDBClusterAccessWhitelistRequest extends $dara.Model {
   /**
    * @remarks
-   * The attribute of the IP address whitelist group. If you set this parameter to \\`hidden\\`, the whitelist group is not visible in the console.
+   * The attribute of the IP whitelist group. If this parameter is set to **hidden**, the group is not displayed in the console.
    * 
-   * > - You cannot hide an IP address whitelist group that is already visible in the console.
-   * >
-   * > - This parameter is available only when **WhiteListType** is set to **IP**.
+   * > - IP whitelist groups that are already displayed in the console cannot be hidden.
+   * > - This parameter takes effect only when **WhiteListType** is set to **IP**.
    * 
    * @example
    * hidden
@@ -17,17 +16,14 @@ export class ModifyDBClusterAccessWhitelistRequest extends $dara.Model {
   DBClusterIPArrayAttribute?: string;
   /**
    * @remarks
-   * The name of the IP address whitelist group. The name must be 2 to 120 characters in length. It must consist of lowercase letters and digits. The name must start with a letter and end with a letter or a digit.
+   * The name of the IP whitelist group. The name must be 2 to 120 characters in length and can contain lowercase letters and digits. The name must start with a letter and end with a letter or digit.
    * 
    * - If the specified whitelist group name does not exist, a new whitelist group is created.
-   * 
    * - If the specified whitelist group name already exists, the whitelist group is modified.
+   * - If this parameter is not specified, the default group is modified. 
    * 
-   * - If you do not specify this parameter, the \\`default\\` group is modified.
-   * 
-   * > * A cluster can have up to 50 IP address whitelist groups.
-   * >
-   * > * This parameter is available only when **WhiteListType** is set to **IP**.
+   * > - A maximum of 50 IP whitelist groups are supported for a cluster.
+   * > - This parameter takes effect only when **WhiteListType** is set to **IP**.
    * 
    * @example
    * default
@@ -45,15 +41,12 @@ export class ModifyDBClusterAccessWhitelistRequest extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
-   * The method used to modify the IP address whitelist. Valid values:
-   * 
-   * - **Cover**: Overwrites the original IP address whitelist. This is the default value.
-   * 
-   * - **Append**: Appends IP addresses to the whitelist.
-   * 
-   * - **Delete**: Deletes IP addresses from the whitelist.
+   * The method used to modify the IP whitelist. Valid values:
+   * - **Cover**: overwrites the original IP whitelist (default value).
+   * - **Append**: appends IP addresses to the whitelist.
+   * - **Delete**: removes IP addresses from the whitelist.
    * 
-   * > This parameter is available only when **WhiteListType** is set to **IP**.
+   * > This parameter takes effect only when **WhiteListType** is set to **IP**.
    * 
    * @example
    * Cover
@@ -61,15 +54,19 @@ export class ModifyDBClusterAccessWhitelistRequest extends $dara.Model {
   modifyMode?: string;
   ownerAccount?: string;
   ownerId?: number;
+  /**
+   * @example
+   * pfs-xxx
+   */
+  pfsInstanceId?: string;
   resourceOwnerAccount?: string;
   resourceOwnerId?: number;
   /**
    * @remarks
-   * The security group ID. Separate multiple security group IDs with commas (,).
+   * The security group IDs. Separate multiple security group IDs with commas (,).
    * 
-   * > - A cluster can be associated with up to three security groups.
-   * >
-   * > - This parameter is available only when **WhiteListType** is set to **SecurityGroup**.
+   * > - A maximum of 3 security groups are supported for a cluster.
+   * > - This parameter takes effect only when **WhiteListType** is set to **SecurityGroup**.
    * 
    * @example
    * sg-*********
@@ -77,13 +74,12 @@ export class ModifyDBClusterAccessWhitelistRequest extends $dara.Model {
   securityGroupIds?: string;
   /**
    * @remarks
-   * The IP addresses or CIDR blocks in the IP address whitelist group. All IP address whitelist groups can contain a total of 1,000 IP addresses or CIDR blocks. Separate multiple IP addresses with commas (,). The following formats are supported:
+   * The IP addresses or CIDR blocks in the IP whitelist group. A maximum of 1,000 IP addresses or CIDR blocks can be added to all IP whitelist groups. Separate multiple IP addresses with commas (,). The following two formats are supported: 
    * 
-   * - IP address format. For example: 10.23.12.24.
+   * - IP address format, such as 10.23.12.24.
+   * - CIDR format, such as 10.23.12.24/24, where 24 indicates the prefix length of the CIDR block. The prefix length ranges from 1 to 32.
    * 
-   * - CIDR format. For example: 10.23.12.24/24. The number 24 indicates the prefix length of the IP address. The prefix length can range from 1 to 32.
-   * 
-   * > This parameter is available only when **WhiteListType** is set to **IP**.
+   * > This parameter takes effect only when **WhiteListType** is set to **IP**.
    * 
    * @example
    * 10.23.12.24
@@ -93,11 +89,10 @@ export class ModifyDBClusterAccessWhitelistRequest extends $dara.Model {
    * @remarks
    * The type of the whitelist. Valid values:
    * 
-   * - **IP**: IP address whitelist group.
-   * 
-   * - **SecurityGroup**: Security group.
+   * - **IP**: IP whitelist group.
+   * - **SecurityGroup**: security group.
    * 
-   * The default value is **IP**.
+   * Default value: **IP**.
    * 
    * @example
    * IP
@@ -111,6 +106,7 @@ export class ModifyDBClusterAccessWhitelistRequest extends $dara.Model {
       modifyMode: 'ModifyMode',
       ownerAccount: 'OwnerAccount',
       ownerId: 'OwnerId',
+      pfsInstanceId: 'PfsInstanceId',
       resourceOwnerAccount: 'ResourceOwnerAccount',
       resourceOwnerId: 'ResourceOwnerId',
       securityGroupIds: 'SecurityGroupIds',
@@ -127,6 +123,7 @@ export class ModifyDBClusterAccessWhitelistRequest extends $dara.Model {
       modifyMode: 'string',
       ownerAccount: 'string',
       ownerId: 'number',
+      pfsInstanceId: 'string',
       resourceOwnerAccount: 'string',
       resourceOwnerId: 'number',
       securityGroupIds: 'string',