@alicloud/ddosbgp20180720 2.7.2 → 3.0.0

package/src/models/DescribeInstanceListRequest.ts

@@ -0,0 +1,214 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeInstanceListRequestTag extends $dara.Model {
+  /**
+   * @remarks
+   * The mitigation plan of the Anti-DDoS Origin instance.
+   * 
+   * @example
+   * test-key
+   */
+  key?: string;
+  /**
+   * @remarks
+   * The mitigation plan of the Anti-DDoS Origin instance. Valid values:
+   * 
+   * *   0: the Professional mitigation plan.
+   * *   1: the Enterprise mitigation plan.
+   * 
+   * @example
+   * test-value
+   */
+  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 DescribeInstanceListRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The number of the page to return.
+   * 
+   * @example
+   * ["ddosbgp-cn-oew1pjrk****"]
+   */
+  instanceIdList?: string;
+  /**
+   * @remarks
+   * The field that is used to sort the Anti-DDoS Origin instances. Set the value to **expireTime**, which indicates that the instances are sorted based on the expiration time.
+   * 
+   * You can set the **Orderdire** parameter to specify the sorting method.
+   * 
+   * @example
+   * 0
+   */
+  instanceType?: string;
+  /**
+   * @remarks
+   * The total number of Anti-DDoS Origin instances.
+   */
+  instanceTypeList?: string[];
+  /**
+   * @remarks
+   * The sorting method. Valid values:
+   * 
+   * *   **desc**: the descending order. This is the default value.
+   * *   **asc**: the ascending order.
+   * 
+   * @example
+   * 47.89.XX.XX
+   */
+  ip?: string;
+  /**
+   * @remarks
+   * The IP address of the object that is protected by the Anti-DDoS Origin instance to query.
+   * 
+   * @example
+   * IPv4
+   */
+  ipVersion?: string;
+  /**
+   * @remarks
+   * The ID of the region where the Anti-DDoS Origin instance to query resides.
+   * 
+   * >  You can call the [DescribeRegions](https://help.aliyun.com/document_detail/118703.html) operation to query the most recent region list.
+   * 
+   * @example
+   * expireTime
+   */
+  orderby?: string;
+  /**
+   * @remarks
+   * The tags that are added to the Anti-DDoS Origin instance.
+   * 
+   * @example
+   * desc
+   */
+  orderdire?: string;
+  /**
+   * @remarks
+   * The protocol type of the IP address asset that is protected by the Anti-DDoS Origin instance to query. Valid values:
+   * 
+   * *   **Ipv4**: IPv4
+   * *   **Ipv6**: IPv6
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * 1
+   */
+  pageNo?: number;
+  /**
+   * @remarks
+   * The mitigation plan of the Anti-DDoS Origin instance to query. Valid values:
+   * 
+   * *   **0**: the Professional mitigation plan
+   * *   **1**: the Enterprise mitigation plan
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * 10
+   */
+  pageSize?: number;
+  /**
+   * @remarks
+   * The tag that is added to the Anti-DDoS Origin instance.
+   * 
+   * @example
+   * cn-hangzhou
+   */
+  regionId?: string;
+  /**
+   * @remarks
+   * The number of entries to return on each page.
+   * 
+   * @example
+   * test
+   */
+  remark?: string;
+  /**
+   * @remarks
+   * The remarks of the Anti-DDoS Origin instance to query. Fuzzy match is supported.
+   * 
+   * @example
+   * rg-acfm2pz25js****
+   */
+  resourceGroupId?: string;
+  /**
+   * @remarks
+   * The key of the tag that is added to the Anti-DDoS Origin instance.
+   */
+  tag?: DescribeInstanceListRequestTag[];
+  static names(): { [key: string]: string } {
+    return {
+      instanceIdList: 'InstanceIdList',
+      instanceType: 'InstanceType',
+      instanceTypeList: 'InstanceTypeList',
+      ip: 'Ip',
+      ipVersion: 'IpVersion',
+      orderby: 'Orderby',
+      orderdire: 'Orderdire',
+      pageNo: 'PageNo',
+      pageSize: 'PageSize',
+      regionId: 'RegionId',
+      remark: 'Remark',
+      resourceGroupId: 'ResourceGroupId',
+      tag: 'Tag',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      instanceIdList: 'string',
+      instanceType: 'string',
+      instanceTypeList: { 'type': 'array', 'itemType': 'string' },
+      ip: 'string',
+      ipVersion: 'string',
+      orderby: 'string',
+      orderdire: 'string',
+      pageNo: 'number',
+      pageSize: 'number',
+      regionId: 'string',
+      remark: 'string',
+      resourceGroupId: 'string',
+      tag: { 'type': 'array', 'itemType': DescribeInstanceListRequestTag },
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.instanceTypeList)) {
+      $dara.Model.validateArray(this.instanceTypeList);
+    }
+    if(Array.isArray(this.tag)) {
+      $dara.Model.validateArray(this.tag);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeInstanceListResponse.ts

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

@@ -0,0 +1,282 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeInstanceListResponseBodyInstanceListAutoProtectCondition extends $dara.Model {
+  /**
+   * @remarks
+   * Events which result in auto binding.
+   */
+  events?: string[];
+  static names(): { [key: string]: string } {
+    return {
+      events: 'Events',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      events: { 'type': 'array', 'itemType': 'string' },
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.events)) {
+      $dara.Model.validateArray(this.events);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class DescribeInstanceListResponseBodyInstanceList extends $dara.Model {
+  /**
+   * @remarks
+   * The event that triggers automatic association. Valid values:
+   * 
+   * *   **any**: The instance is automatically associated with an object based on traffic scrubbing events or blackhole filtering events.
+   * *   **clean**: The instance is automatically associated with an object based on traffic scrubbing events.
+   * *   **blackhole**: The instance is automatically associated with an object based on blackhole filtering events.
+   */
+  autoProtectCondition?: DescribeInstanceListResponseBodyInstanceListAutoProtectCondition;
+  /**
+   * @remarks
+   * The time when the instance expires. The value is a UNIX timestamp. Unit: milliseconds.
+   * 
+   * @example
+   * false
+   */
+  autoRenewal?: boolean;
+  /**
+   * @remarks
+   * The type of the instance.
+   * 
+   * *   **ddos_ddosorigin_public_cn**: Anti-DDoS Origin 2.0 (Pay-as-you-go) on the China site (aliyun.com).
+   * *   **ddos_ddosorigin_public_intl**: Anti-DDoS Origin 2.0 (Pay-as-you-go) on the International site (alibabacloud.com).
+   * 
+   * @example
+   * 0
+   */
+  blackholdingCount?: string;
+  /**
+   * @remarks
+   * The condition that triggers automatic association of the instance with an object.
+   * 
+   * @example
+   * ddos_ddosorigin_public_cn
+   */
+  commodityType?: string;
+  /**
+   * @remarks
+   * Indicates whether overdue payments exist. Valid values:
+   * 
+   * *   **0**: Overdue payments do not exist.
+   * *   **1**: Overdue payments exist.
+   * 
+   * @example
+   * 1
+   */
+  coverageType?: number;
+  /**
+   * @remarks
+   * The events that trigger automatic association.
+   * 
+   * @example
+   * 0
+   */
+  debtStatus?: number;
+  /**
+   * @remarks
+   * The time when the instance was purchased. The value is a UNIX timestamp. Unit: milliseconds.
+   * 
+   * @example
+   * 1640275200000
+   */
+  expireTime?: number;
+  /**
+   * @remarks
+   * The mitigation plan of the instance. Valid values:
+   * 
+   * *   **0**: the Professional mitigation plan
+   * *   **1**: the Enterprise mitigation plan
+   * 
+   * @example
+   * 1592886047000
+   */
+  gmtCreate?: number;
+  /**
+   * @remarks
+   * The number of protected public IP addresses for which blackhole filtering is triggered.
+   * 
+   * >  You can call the [DeleteBlackhole](https://help.aliyun.com/document_detail/118692.html) operation to deactivate blackhole filtering for a protected IP address.
+   * 
+   * @example
+   * ddosbgp-cn-oew1pjrk****
+   */
+  instanceId?: string;
+  /**
+   * @remarks
+   * The application scope of the instance.
+   * 
+   * *   **1**: The instance supports public IP addresses in all regions.
+   * *   **2**: The instance supports public IP addresses in regions in the Chinese mainland.
+   * *   **3**: The instance supports public IP addresses in regions outside the Chinese mainland.
+   * *   **4**: The instance supports public IP addresses in a region in or outside the Chinese mainland.
+   * 
+   * @example
+   * 1
+   */
+  instanceType?: string;
+  /**
+   * @remarks
+   * The description of the instance.
+   * 
+   * @example
+   * IPv4
+   */
+  ipType?: string;
+  /**
+   * @remarks
+   * The ID of the instance.
+   * 
+   * @example
+   * gamebox
+   */
+  product?: string;
+  /**
+   * @remarks
+   * The type of the cloud service that is associated with the Anti-DDoS Origin instance By default, this parameter is not returned. If the Anti-DDoS Origin instance is created by using a different cloud service, the code of the cloud service is returned.
+   * 
+   * Valid values:
+   * 
+   * *   **gamebox**: The Anti-DDoS Origin instance is created by using Game Security Box.
+   * *   **eip**: The Anti-DDoS Origin instance is created by using an elastic IP address (EIP) for which Anti-DDoS (Enhanced Edition) is enabled.
+   * 
+   * @example
+   * test
+   */
+  remark?: string;
+  /**
+   * @remarks
+   * The resource group ID.
+   * 
+   * @example
+   * rg-aek3ccjxxxxx
+   */
+  resourceGroupId?: string;
+  /**
+   * @remarks
+   * Indicates whether auto-renewal is enabled for the instance. Valid values:
+   * 
+   * *   **true**
+   * *   **false**
+   * 
+   * @example
+   * 1
+   */
+  status?: string;
+  static names(): { [key: string]: string } {
+    return {
+      autoProtectCondition: 'AutoProtectCondition',
+      autoRenewal: 'AutoRenewal',
+      blackholdingCount: 'BlackholdingCount',
+      commodityType: 'CommodityType',
+      coverageType: 'CoverageType',
+      debtStatus: 'DebtStatus',
+      expireTime: 'ExpireTime',
+      gmtCreate: 'GmtCreate',
+      instanceId: 'InstanceId',
+      instanceType: 'InstanceType',
+      ipType: 'IpType',
+      product: 'Product',
+      remark: 'Remark',
+      resourceGroupId: 'ResourceGroupId',
+      status: 'Status',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      autoProtectCondition: DescribeInstanceListResponseBodyInstanceListAutoProtectCondition,
+      autoRenewal: 'boolean',
+      blackholdingCount: 'string',
+      commodityType: 'string',
+      coverageType: 'number',
+      debtStatus: 'number',
+      expireTime: 'number',
+      gmtCreate: 'number',
+      instanceId: 'string',
+      instanceType: 'string',
+      ipType: 'string',
+      product: 'string',
+      remark: 'string',
+      resourceGroupId: 'string',
+      status: 'string',
+    };
+  }
+
+  validate() {
+    if(this.autoProtectCondition && typeof (this.autoProtectCondition as any).validate === 'function') {
+      (this.autoProtectCondition as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class DescribeInstanceListResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The details about the Anti-DDoS Origin instances.
+   */
+  instanceList?: DescribeInstanceListResponseBodyInstanceList[];
+  /**
+   * @remarks
+   * The details about the Anti-DDoS Origin instance.
+   * 
+   * @example
+   * 381D5D33-BB8F-395F-8EE4-AE3BB4B523C4
+   */
+  requestId?: string;
+  /**
+   * @remarks
+   * The details about the Anti-DDoS Origin instances.
+   * 
+   * @example
+   * 1
+   */
+  total?: number;
+  static names(): { [key: string]: string } {
+    return {
+      instanceList: 'InstanceList',
+      requestId: 'RequestId',
+      total: 'Total',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      instanceList: { 'type': 'array', 'itemType': DescribeInstanceListResponseBodyInstanceList },
+      requestId: 'string',
+      total: 'number',
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.instanceList)) {
+      $dara.Model.validateArray(this.instanceList);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeInstanceSpecsRequest.ts

@@ -0,0 +1,62 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeInstanceSpecsRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The ID of the Anti-DDoS Origin instance. This parameter is a string that consists of JSON arrays. Each element in a JSON array indicates an instance ID. If you want to query more than one instance, separate instance IDs with commas (,).
+   * 
+   * >  You can call the [DescribeInstanceList](https://help.aliyun.com/document_detail/118698.html) operation to query the IDs of all Anti-DDoS Origin instances in a specific region.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * ["ddosbgp-cn-n6w1r7nz****"]
+   */
+  instanceIdList?: string;
+  /**
+   * @remarks
+   * The region ID of the Anti-DDoS Origin instance. Default value: **cn-hangzhou**, which indicates the China (Hangzhou) region.
+   * 
+   * >  If your instance does not reside in the China (Hangzhou) region, you must set this parameter to the region ID of your instance. You can call the [DescribeRegions](https://help.aliyun.com/document_detail/118703.html) operation to query the regions of assets that can be protected by Anti-DDoS Origin in a specific region.
+   * 
+   * @example
+   * cn-hangzhou
+   */
+  regionId?: string;
+  /**
+   * @remarks
+   * The ID of the resource group to which the Anti-DDoS Origin instance belongs in Resource Management. This parameter is empty by default, which indicates that the Anti-DDoS Origin instance belongs to the default resource group.
+   * 
+   * For information about resource groups, see [Create a resource group](https://help.aliyun.com/document_detail/94485.html).
+   * 
+   * @example
+   * rg-acfm2pz25js****
+   */
+  resourceGroupId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      instanceIdList: 'InstanceIdList',
+      regionId: 'RegionId',
+      resourceGroupId: 'ResourceGroupId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      instanceIdList: 'string',
+      regionId: 'string',
+      resourceGroupId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeInstanceSpecsResponse.ts

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