@alicloud/alidns20150109 3.4.3 → 3.4.5

package/dist/client.d.ts

@@ -4775,21 +4775,38 @@ export declare class DescribeCloudGtmInstanceConfigAlertResponse extends $tea.Mo
 }
 export declare class DescribeCloudGtmInstanceConfigFullInfoRequest extends $tea.Model {
     /**
+     * @remarks
+     * The language of the response. Valid values:
+     *
+     * *   zh-CN: Chinese
+     * *   en-US (default): English
+     *
      * @example
      * en-US
      */
     acceptLanguage?: string;
     /**
+     * @remarks
+     * The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.
+     *
      * @example
      * 1ae05db4-10e7-11ef-b126-00163e24**22
      */
     clientToken?: string;
     /**
+     * @remarks
+     * The configuration ID of the access domain name. Two configuration IDs exist when the access domain name is bound to the same GTM instance but an A record and an AAAA record are configured for the access domain name. The configuration ID uniquely identifies a configuration.
+     *
+     * You can call the [ListCloudGtmInstanceConfigs](~~ListCloudGtmInstanceConfigs~~) operation to query the value of ConfigId for the access domain name.
+     *
      * @example
      * Config-000**11
      */
     configId?: string;
     /**
+     * @remarks
+     * The ID of the GTM 3.0 instance.
+     *
      * @example
      * gtm-cn-wwo3a3hbz**
      */
@@ -4806,118 +4823,227 @@ export declare class DescribeCloudGtmInstanceConfigFullInfoRequest extends $tea.
 }
 export declare class DescribeCloudGtmInstanceConfigFullInfoResponseBody extends $tea.Model {
     /**
+     * @remarks
+     * The policy for load balancing between address pools. Valid values:
+     *
+     * *   round_robin: All address pools are returned for DNS requests from any source. All address pools are sorted in round-robin mode each time they are returned.
+     * *   sequence: The address pool with the smallest sequence number is preferentially returned for DNS requests from any source. The sequence number indicates the priority for returning the address pool. A smaller sequence number indicates a higher priority. If the address pool with the smallest sequence number is unavailable, the address pool with the second smallest sequence number is returned.
+     * *   weight: You can set a different weight value for each address pool. This way, address pools are returned based on the weight values.
+     * *   source_nearest: GTM returns different addresses based on the sources of DNS requests. This way, users can access nearby addresses.
+     *
      * @example
      * round_robin
      */
     addressPoolLbStrategy?: string;
+    /**
+     * @remarks
+     * The address pools.
+     */
     addressPools?: DescribeCloudGtmInstanceConfigFullInfoResponseBodyAddressPools;
     /**
+     * @remarks
+     * Alert notification configuration.
+     *
      * @example
      * [{\\"NoticeType\\":\\"addr_alert\\",\\"SmsNotice\\":true,\\"EmailNotice\\":true,\\"DingtalkNotice\\":true},{\\"NoticeType\\":\\"addr_resume\\",\\"SmsNotice\\":true,\\"EmailNotice\\":true,\\"DingtalkNotice\\":true},{\\"NoticeType\\":\\"addr_pool_unavailable\\",\\"SmsNotice\\":true,\\"EmailNotice\\":true,\\"DingtalkNotice\\":true},{\\"NoticeType\\":\\"addr_pool_available\\",\\"SmsNotice\\":true,\\"EmailNotice\\":true,\\"DingtalkNotice\\":true}]"
      */
     alertConfig?: string;
+    /**
+     * @remarks
+     * Alert notification group.
+     *
+     * @example
+     * [\\"Default Contact Group\\"]
+     */
     alertGroup?: string;
     /**
+     * @remarks
+     * The availability state of the access domain name. Valid values:
+     *
+     * *   available: If the access domain name is **enabled** and the health state of the access domain name is **Normal**, the access domain name is deemed **available**.
+     * *   unavailable: If the access domain name is **disabled** or the health state of the access domain name is **Abnormal**, the access domain name is deemed **unavailable**.
+     *
      * @example
      * available
      */
     availableStatus?: string;
     /**
+     * @remarks
+     * The commodity code. Valid values:
+     *
+     * *   dns_gtm_public_cn: the commodity code on the China site (aliyun.com)
+     * *   dns_gtm_public_intl: the commodity code on the international site (alibabacloud.com)
+     *
      * @example
      * dns_gtm_public_cn
      */
     commodityCode?: string;
     /**
+     * @remarks
+     * The configuration ID of the access domain name. Two configuration IDs exist when the access domain name is bound to the same GTM instance but an A record and an AAAA record are configured for the access domain name. The configuration ID uniquely identifies a configuration.
+     *
      * @example
      * Config-000**11
      */
     configId?: string;
     /**
+     * @remarks
+     * Instance creation time.
+     *
      * @example
      * 2024-03-15T01:46Z
      */
     createTime?: string;
     /**
+     * @remarks
+     * Instance creation time (timestamp).
+     *
      * @example
      * 1527690629357
      */
     createTimestamp?: number;
     /**
+     * @remarks
+     * The enabling state of the access domain name. Valid values:
+     *
+     * *   enable: The access domain name is enabled and the intelligent scheduling policy of the corresponding GTM instance takes effect.
+     * *   disable: The access domain name is disabled and the intelligent scheduling policy of the corresponding GTM instance does not take effect.
+     *
      * @example
      * enable
      */
     enableStatus?: string;
     /**
+     * @remarks
+     * The health state of the access domain name. Valid values:
+     *
+     * *   ok: The health state of the access domain name is Normal and all address pools that are referenced by the access domain name are available.
+     * *   ok_alert: The health state of the access domain name is Warning and some of the address pools that are referenced by the access domain name are unavailable. In this case, the available address pools are normally used for DNS resolution, but the unavailable address pools cannot be used for DNS resolution.
+     * *   exceptional: The health state of the access domain name is Abnormal and all address pools that are referenced by the access domain name are unavailable. In this case, addresses in the non-empty address pool with the smallest sequence number are preferentially used for fallback resolution. This returns DNS results for clients as much as possible.
+     *
      * @example
      * ok
      */
     healthStatus?: string;
     /**
+     * @remarks
+     * The ID of the GTM 3.0 instance.
+     *
      * @example
      * gtm-cn-wwo3a3hbz**
      */
     instanceId?: string;
     /**
+     * @remarks
+     * Schedule instance name.
+     *
      * @example
      * test
      */
     instanceName?: string;
     /**
+     * @remarks
+     * Remarks of the configuration of domain instance.
+     *
      * @example
      * test
      */
     remark?: string;
     /**
+     * @remarks
+     * Unique request identification code.
+     *
      * @example
      * 29D0F8F8-5499-4F6C-9FDC-1EE13BF55925
      */
     requestId?: string;
     /**
+     * @remarks
+     * The GTM access domain name. The value of this parameter is composed of the value of ScheduleHostname and the value of ScheduleZoneName.
+     *
      * @example
      * www.example.com
      */
     scheduleDomainName?: string;
     /**
+     * @remarks
+     * Host name of the domain accessed by GTM.
+     *
      * @example
      * www
      */
     scheduleHostname?: string;
     /**
+     * @remarks
+     * DNS record types for the ScheduleDomainName:
+     * - A: IPv4 address
+     * - AAAA: IPv6 address
+     * - CNAME: Domain name
+     *
      * @example
      * A
      */
     scheduleRrType?: string;
     /**
+     * @remarks
+     * The allocation mode of the access domain name. Valid values:
+     *
+     * *   custom: custom allocation. You must specify a custom hostname and associate the hostname with a zone or subzone within the account to which the GTM instance belongs to generate an access domain name.
+     * *   sys_assign: The system assigns an access domain name by default. This mode is no longer supported. Do not choose this mode.
+     *
      * @example
      * custom
      */
     scheduleZoneMode?: string;
     /**
+     * @remarks
+     * The zone (such as example.com) or subzone (such as a.example.com) associated with the GTM access domain name. In most cases, the zone or subzone is hosted in Authoritative DNS Resolution of the Alibaba Cloud DNS console within the account to which the GTM instance belongs.
+     *
      * @example
      * example.com
      */
     scheduleZoneName?: string;
     /**
+     * @remarks
+     * The mode used if the address pool with the smallest sequence number is recovered. This parameter is required when AddressPoolLbStrategy is set to sequence. Valid values:
+     *
+     * *   preemptive: The address pool with the smallest sequence number is preferentially used if this address pool is recovered.
+     * *   non_preemptive: The current address pool is still used even if the address pool with the smallest sequence number is recovered.
+     *
      * @example
      * preemptive
      */
     sequenceLbStrategyMode?: string;
     /**
+     * @remarks
+     * Global TTL (in seconds), the TTL value for resolving the access domain to addresses in the address pool, which affects the caching time of DNS records in the ISP\\"s LocalDNS. Custom TTL values are supported.
+     *
      * @example
      * 60
      */
     ttl?: number;
     /**
+     * @remarks
+     * Last modified time.
+     *
      * @example
      * 2024-03-15T01:46Z
      */
     updateTime?: string;
     /**
+     * @remarks
+     * Last modified time (timestamp).
+     *
      * @example
      * 1527690629357
      */
     updateTimestamp?: number;
     /**
+     * @remarks
+     * Global Traffic Management version 3.0 instances:
+     * - standard: Standard Edition
+     * - ultimate: Ultimate Edition
+     *
      * @example
      * ultimate
      */
@@ -22791,93 +22917,188 @@ export declare class DescribeCloudGtmInstanceConfigFullInfoResponseBodyAddressPo
 }
 export declare class DescribeCloudGtmInstanceConfigFullInfoResponseBodyAddressPoolsAddressPoolAddressesAddress extends $tea.Model {
     /**
+     * @remarks
+     * IP address or domain name.
+     *
      * @example
      * 223.5.XX.XX
      */
     address?: string;
     /**
+     * @remarks
+     * The address ID. This ID uniquely identifies the address.
+     *
      * @example
      * addr-89564712295703**96
      */
     addressId?: string;
+    /**
+     * @remarks
+     * Address ownership information, not supported in the current version.
+     *
+     * @example
+     * The current version does not support returning this parameter.
+     */
     attributeInfo?: string;
     /**
+     * @remarks
+     * The failover mode that is used when address exceptions are identified. Valid values:
+     *
+     * *   auto: the automatic mode. The system determines whether to return an address based on the health check results. If the address fails health checks, the system does not return the address. If the address passes health checks, the system returns the address.
+     * *   manual: the manual mode. If an address is in the unavailable state, the address is not returned for DNS requests even if the address passes health checks. If an address is in the available state, the address is returned for DNS requests even if an alert is triggered when the address fails health checks.
+     *
      * @example
      * auto
      */
     availableMode?: string;
     /**
+     * @remarks
+     * The availability state of the address. Valid values:
+     *
+     * *   available
+     * *   unavailable
+     *
      * @example
      * available
      */
     availableStatus?: string;
     /**
+     * @remarks
+     * Address creation time.
+     *
      * @example
      * 2024-03-15T01:46Z
      */
     createTime?: string;
     /**
+     * @remarks
+     * Address creation time (timestamp).
+     *
      * @example
      * 1527690629357
      */
     createTimestamp?: number;
     /**
+     * @remarks
+     * The enabling state of the address. Valid values:
+     *
+     * *   enable
+     * *   disable
+     *
      * @example
      * enable
      */
     enableStatus?: string;
     /**
+     * @remarks
+     * The condition for determining the health state of the address. Valid values:
+     *
+     * *   any_ok: The health check results of at least one health check template are normal.
+     * *   p30_ok: The health check results of at least 30% of health check templates are normal.
+     * *   p50_ok: The health check results of at least 50% of health check templates are normal.
+     * *   p70_ok: The health check results of at least 70% of health check templates are normal.
+     * *   all_ok: The health check results of all health check templates are normal.
+     *
      * @example
      * any_ok
      */
     healthJudgement?: string;
     /**
+     * @remarks
+     * The health check state of the address. Valid values:
+     *
+     * *   ok: The address passes all health checks of the referenced health check templates.
+     * *   ok_alert: The address fails some health checks of the referenced health check templates but the address is deemed normal.
+     * *   ok_no_monitor: The address does not reference any health check template and is normal.
+     * *   exceptional: The address fails some or all health checks of the referenced health check templates and the address is deemed abnormal.
+     *
      * @example
      * ok
      */
     healthStatus?: string;
     /**
+     * @remarks
+     * The availability state of the address when AvailableMode is set to manual. Valid values:
+     *
+     * *   available: The address is normal. In this state, the address is returned for DNS requests even if an alert is triggered when the address fails health checks.
+     * *   unavailable: The address is abnormal. In this state, the address is not returned for DNS requests even if the address passes health checks.
+     *
      * @example
      * available
      */
     manualAvailableStatus?: string;
     /**
+     * @remarks
+     * Address name.
+     *
      * @example
      * Address-1
      */
     name?: string;
     /**
+     * @remarks
+     * The remark of the address.
+     *
      * @example
      * test
      */
     remark?: string;
+    /**
+     * @remarks
+     * Request source list.
+     */
     requestSource?: DescribeCloudGtmInstanceConfigFullInfoResponseBodyAddressPoolsAddressPoolAddressesAddressRequestSource;
     /**
+     * @remarks
+     * Indicates whether it is a sequential (non-preemptive) mode scheduling object, applicable to hybrid cloud management scenarios:
+     *
+     * - true: yes
+     * - false: no
+     *
      * @example
      * false
      */
     seqNonPreemptiveSchedule?: boolean;
     /**
+     * @remarks
+     * Sequence number, indicating the priority of address return, where smaller numbers have higher priority.
+     *
      * @example
      * 1
      */
     serialNumber?: number;
     /**
+     * @remarks
+     * The type of the address. Valid values:
+     *
+     * *   IPV4: the IPv4 address
+     * *   IPv6: the IPv6 address
+     * *   domain: the domain name
+     *
      * @example
      * IPv4
      */
     type?: string;
     /**
+     * @remarks
+     * Last modified time of the address.
+     *
      * @example
      * 2024-03-15T01:46Z
      */
     updateTime?: string;
     /**
+     * @remarks
+     * The last modification time of the address (timestamp).
+     *
      * @example
      * 1527690629357
      */
     updateTimestamp?: number;
     /**
+     * @remarks
+     * Weight value (an integer between 1 and 100, inclusive), allowing different weight values to be set for each address, enabling resolution queries to return addresses in proportion to their weights.
+     *
      * @example
      * 1
      */
@@ -22918,83 +23139,166 @@ export declare class DescribeCloudGtmInstanceConfigFullInfoResponseBodyAddressPo
 }
 export declare class DescribeCloudGtmInstanceConfigFullInfoResponseBodyAddressPoolsAddressPool extends $tea.Model {
     /**
+     * @remarks
+     * Load balancing policy among addresses in the address pool:
+     * - round_robin: Round-robin, for any source of DNS resolution requests, returns all addresses and rotates their order for each request.
+     * - sequence: Sequential, for any source of DNS resolution requests, returns the address with the smaller sequence number (the sequence number indicates the priority of the address return, with smaller numbers having higher priority). If the address with the smaller sequence number is unavailable, the next address with a smaller sequence number is returned.
+     * - weight: Weighted, supports setting different weight values for each address to realize returning addresses according to the weight ratio for resolution queries.
+     * - source_nearest: Source-nearest, i.e., intelligent resolution function, where GTM can return different addresses based on the source of different DNS resolution requests, achieving the effect of users accessing nearby.
+     *
      * @example
      * round_robin
      */
     addressLbStrategy?: string;
     /**
+     * @remarks
+     * The ID of the address pool. This ID uniquely identifies the address pool.
+     *
      * @example
      * pool-89528023225442**16
      */
     addressPoolId?: string;
     /**
+     * @remarks
+     * Address pool name.
+     *
      * @example
      * AddressPool-1
      */
     addressPoolName?: string;
     /**
+     * @remarks
+     * Address pool type:
+     * - IPv4
+     * - IPv6
+     * - domain
+     *
      * @example
      * IPv4
      */
     addressPoolType?: string;
+    /**
+     * @remarks
+     * The addresses.
+     */
     addresses?: DescribeCloudGtmInstanceConfigFullInfoResponseBodyAddressPoolsAddressPoolAddresses;
     /**
+     * @remarks
+     * The availability state of the address pool. Valid values:
+     *
+     * *   Available
+     * *   unavailable
+     *
      * @example
      * available
      */
     availableStatus?: string;
     /**
+     * @remarks
+     * Address pool creation time.
+     *
      * @example
      * 2024-03-15T01:46Z
      */
     createTime?: string;
     /**
+     * @remarks
+     * Address pool creation time (timestamp).
+     *
      * @example
      * 1527690629357
      */
     createTimestamp?: number;
     /**
+     * @remarks
+     * The enabling state of the address pool. Valid values:
+     *
+     * *   enable
+     * *   disable
+     *
      * @example
      * enable
      */
     enableStatus?: string;
     /**
+     * @remarks
+     * The condition for determining the health state of the address pool. Valid values:
+     *
+     * *   any_ok: At least one address in the address pool is available.
+     * *   p30_ok: At least 30% of the addresses in the address pool are available.
+     * *   p50_ok: At least 50% of the addresses in the address pool are available.
+     * *   p70_ok: At least 70% of the addresses in the address pool are available.
+     * *   all_ok: All addresses in the address pool are available.
+     *
      * @example
      * any_ok
      */
     healthJudgement?: string;
     /**
+     * @remarks
+     * Address pool health status:
+     * - ok: Normal, all addresses referenced by the address pool are available.
+     * - ok_alert: Warning, some addresses referenced by the address pool are unavailable, but the address pool status is deemed normal. In the warning state, available address pools are resolved normally, while unavailable ones stop resolving.
+     * - exceptional: Abnormal, some or all of the addresses referenced by the address pool are unavailable, and the address pool status is determined to be abnormal.
+     *
      * @example
      * ok
      */
     healthStatus?: string;
+    /**
+     * @remarks
+     * Parse the list of request sources.
+     */
     requestSource?: DescribeCloudGtmInstanceConfigFullInfoResponseBodyAddressPoolsAddressPoolRequestSource;
     /**
+     * @remarks
+     * Indicates whether it is a sequential (non-preemptive) scheduling object for hybrid cloud management scenarios:
+     * - true: yes
+     * - false: no
+     *
      * @example
      * false
      */
     seqNonPreemptiveSchedule?: boolean;
     /**
+     * @remarks
+     * The mode used if the address with the smallest sequence number is recovered. This parameter is required only when AddressLbStrategy is set to sequence. Valid values:
+     *
+     * *   preemptive: The address with the smallest sequence number is preferentially used if this address is recovered.
+     * *   non_preemptive: The current address is still used even if the address with the smallest sequence number is recovered.
+     *
      * @example
      * preemptive
      */
     sequenceLbStrategyMode?: string;
     /**
+     * @remarks
+     * Sequence number. For any parsing request from any source, the address pool with the smaller sequence number is returned (the sequence number indicates the priority of the address pool returned, with smaller numbers having higher priority).
+     *
      * @example
      * 1
      */
     serialNumber?: number;
     /**
+     * @remarks
+     * Last modification time of the address pool.
+     *
      * @example
      * 2024-03-15T01:46Z
      */
     updateTime?: string;
     /**
+     * @remarks
+     * Last modification time of the address pool (timestamp).
+     *
      * @example
      * 1527690629357
      */
     updateTimestamp?: number;
     /**
+     * @remarks
+     * Weight value (an integer between 1 and 100, inclusive), allowing different weight values to be set for each address pool, enabling resolution queries to return address pools according to the weighted ratio.
+     *
      * @example
      * 1
      */
@@ -28204,6 +28508,7 @@ export declare class DescribeInternetDnsLogsResponseBodyLogsLog extends $tea.Mod
      * 1709196249000
      */
     logTime?: number;
+    protocol?: string;
     /**
      * @example
      * example.com
@@ -28543,9 +28848,12 @@ export declare class DescribePdnsThreatStatisticsResponseBodyData extends $tea.M
 }
 export declare class DescribePdnsUdpIpSegmentsResponseBodyIpSegments extends $tea.Model {
     createDate?: string;
+    createTimestamp?: number;
+    id?: string;
     ip?: string;
     mask?: number;
     name?: string;
+    secretKey?: string;
     state?: string;
     updateDate?: string;
     static names(): {
@@ -28561,6 +28869,7 @@ export declare class DescribePdnsUdpIpSegmentsResponseBodyIpSegments extends $te
 export declare class DescribePdnsUserInfoResponseBodyUserInfo extends $tea.Model {
     availableService?: string;
     pdnsId?: number;
+    secretKey?: string;
     serviceType?: string;
     state?: string;
     statisticSwitchStatus?: string;
@@ -32429,12 +32738,16 @@ export default class Client extends OpenApi {
      */
     describeCloudGtmInstanceConfigAlert(request: DescribeCloudGtmInstanceConfigAlertRequest): Promise<DescribeCloudGtmInstanceConfigAlertResponse>;
     /**
+     * Queries the complete configuration information about a Global Traffic Manager (GTM) instance, including the details about the access domain name, alert notifications, address pools, and addresses.
+     *
      * @param request - DescribeCloudGtmInstanceConfigFullInfoRequest
      * @param runtime - runtime options for this request RuntimeOptions
      * @returns DescribeCloudGtmInstanceConfigFullInfoResponse
      */
     describeCloudGtmInstanceConfigFullInfoWithOptions(request: DescribeCloudGtmInstanceConfigFullInfoRequest, runtime: $Util.RuntimeOptions): Promise<DescribeCloudGtmInstanceConfigFullInfoResponse>;
     /**
+     * Queries the complete configuration information about a Global Traffic Manager (GTM) instance, including the details about the access domain name, alert notifications, address pools, and addresses.
+     *
      * @param request - DescribeCloudGtmInstanceConfigFullInfoRequest
      * @returns DescribeCloudGtmInstanceConfigFullInfoResponse
      */