tencentcloud-sdk-nodejs-teo 4.0.695 → 4.0.697

package/src/services/teo/v20220901/teo_models.ts

@@ -159,6 +159,16 @@ export interface CheckCnameStatusResponse {
   RequestId?: string
 }
 
+/**
+ * ModifyZone返回参数结构体
+ */
+export interface ModifyZoneResponse {
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
 /**
  * DescribeOriginGroup返回参数结构体
  */
@@ -367,28 +377,28 @@ export interface DescribeZonesRequest {
    */
   Offset?: number
   /**
-   * 分页查询限制数目。默认值：20，最大值：1000。
+   * 分页查询限制数目。默认值：20，最大值：100。
    */
   Limit?: number
   /**
-   * 过滤条件，Filters.Values的上限为20。详细的过滤条件如下：
-<li>zone-name<br>   按照【<strong>站点名称</strong>】进行过滤。<br>   类型：String<br>   必选：否</li><li>zone-id<br>   按照【<strong>站点ID</strong>】进行过滤。站点ID形如：zone-xxx。<br>   类型：String<br>   必选：否</li><li>status<br>   按照【<strong>站点状态</strong>】进行过滤。<br>   类型：String<br>   必选：否</li><li>tag-key<br>   按照【<strong>标签键</strong>】进行过滤。<br>   类型：String<br>   必选：否</li><li>tag-value<br>   按照【<strong>标签值</strong>】进行过滤。<br>   类型：String<br>   必选：否</li>模糊查询时仅支持过滤字段名为zone-name。
+   * 过滤条件，Filters.Values 的上限为 20。该参数不填写时，返回当前 appid 下有权限的所有站点信息。详细的过滤条件如下：
+<li>zone-name：按照站点名称进行过滤；</li><li>zone-id：按照站点 ID进行过滤。站点 ID 形如：zone-2noz78a8ev6k；</li><li>status：按照站点状态进行过滤；</li><li>tag-key：按照标签键进行过滤；</li><li>tag-value： 按照标签值进行过滤。</li>模糊查询时仅支持过滤字段名为 zone-name。
    */
   Filters?: Array<AdvancedFilter>
   /**
-   * 排序字段，取值有：
+   * 可根据该字段对返回结果进行排序，取值有：
 <li> type：接入类型；</li>
 <li> area：加速区域；</li>
 <li> create-time：创建时间；</li>
 <li> zone-name：站点名称；</li>
 <li> use-time：最近使用时间；</li>
-<li> active-status：生效状态。</li>不填写使用默认值create-time。
+<li> active-status：生效状态。</li>不填写时对返回结果默认按照 create-time 排序。
    */
   Order?: string
   /**
-   * 排序方向，取值有：
+   * 排序方向，如果是字段值为数字，则根据数字大小排序；如果字段值为文本，则根据 ascill 码的大小排序。取值有：
 <li> asc：从小到大排序；</li>
-<li> desc：从大到小排序。</li>不填写使用默认值desc。
+<li> desc：从大到小排序。</li>不填写使用默认值 desc。
    */
   Direction?: string
 }
@@ -455,6 +465,16 @@ export interface DiffIPWhitelist {
   NoChangeIPWhitelist: IPWhitelist
 }
 
+/**
+ * VerifyOwnership请求参数结构体
+ */
+export interface VerifyOwnershipRequest {
+  /**
+   * 站点或者加速域名。
+   */
+  Domain: string
+}
+
 /**
  * DeleteSecurityIPGroup返回参数结构体
  */
@@ -689,6 +709,20 @@ export interface ModifyZoneStatusRequest {
   Paused: boolean
 }
 
+/**
+ * CNAME 接入，使用文件验证时所需的信息。
+ */
+export interface FileVerification {
+  /**
+   * EdgeOne 后台服务器将通过 Scheme + Host + URL Path 的格式（例如 https://www.example.com/.well-known/teo-verification/z12h416twn.txt）获取文件验证信息。该字段为您需要创建的 URL Path 部分。
+   */
+  Path?: string
+  /**
+   * 验证文件的内容。该字段的内容需要您填写至 Path 字段返回的 txt 文件中。
+   */
+  Content?: string
+}
+
 /**
  * DescribeIdentifications返回参数结构体
  */
@@ -1070,7 +1104,7 @@ export interface OriginInfo {
 <li>ORIGIN_GROUP：源站组类型源站；</li>
 <li>AWS_S3：S3兼容对象存储源站；</li>
 <li>LB: 负载均衡类型源站；</li>
-<li>SPACE：EdgeOne Shield Space 存储。</li>
+<li>SPACE：EdgeOne Shield Space 存储。</li>  
    */
   OriginType: string
   /**
@@ -1148,13 +1182,21 @@ export interface ModifyZoneStatusResponse {
 }
 
 /**
- * ModifyZone返回参数结构体
+ * CNAME 接入，使用 DNS 解析验证时所需的信息。
  */
-export interface ModifyZoneResponse {
+export interface DnsVerification {
   /**
-   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   * 主机记录。
    */
-  RequestId?: string
+  Subdomain?: string
+  /**
+   * 记录类型。
+   */
+  RecordType?: string
+  /**
+   * 记录值。
+   */
+  RecordValue?: string
 }
 
 /**
@@ -1723,17 +1765,26 @@ export interface ModifyHostsCertificateRequest {
    */
   ZoneId: string
   /**
-   * 本次变更的域名列表。
+   * 需要修改证书配置的加速域名。
    */
   Hosts: Array<string>
   /**
-   * 证书信息, 只需要传入 CertId 即可, 如果为空, 则使用默认证书。
+   * 配置证书的模式，取值有：
+<li>disable：不配置证书；</li>
+<li>eofreecert：配置 EdgeOne 免费证书；</li>
+<li>sslcert：配置 SSL 证书。</li>不填时默认取值为 disable。
+   */
+  Mode?: string
+  /**
+   * SSL 证书配置，本参数仅在 mode = sslcert 时生效，传入对应证书的 CertId 即可。您可以前往 [SSL 证书列表](https://console.cloud.tencent.com/certoverview) 查看 CertId。
    */
   ServerCertInfo?: Array<ServerCertInfo>
   /**
    * 托管类型，取值有：
-<li>apply：托管EO；</li>
-<li>none：不托管EO；</li>不填，默认取值为none。
+<li>none：不托管EO；</li>
+<li>apply：托管EO</li>
+不填，默认取值为none。
+   * @deprecated
    */
   ApplyType?: string
 }
@@ -1877,107 +1928,114 @@ export interface ModifyAccelerationDomainStatusesResponse {
  */
 export interface Zone {
   /**
-   * 站点ID。
+   * 站点 ID。
    */
-  ZoneId: string
+  ZoneId?: string
   /**
    * 站点名称。
    */
-  ZoneName: string
+  ZoneName?: string
   /**
    * 站点当前使用的 NS 列表。
    */
-  OriginalNameServers: Array<string>
+  OriginalNameServers?: Array<string>
   /**
    * 腾讯云分配的 NS 列表。
    */
-  NameServers: Array<string>
+  NameServers?: Array<string>
   /**
    * 站点状态，取值有：
 <li> active：NS 已切换； </li>
 <li> pending：NS 未切换；</li>
 <li> moved：NS 已切走；</li>
 <li> deactivated：被封禁。 </li>
+<li> initializing：待绑定套餐。 </li>
    */
-  Status: string
+  Status?: string
   /**
-   * 站点接入方式，取值有
-<li> full：NS 接入； </li>
+   * 站点接入方式，取值有：
+<li> full：NS 接入；</li>
 <li> partial：CNAME 接入；</li>
-<li> noDomainAccess：无域名接入。</li>
+<li> noDomainAccess：无域名接入；</li>
+<li> vodeo：vodeo默认站点。</li>
    */
-  Type: string
+  Type?: string
   /**
    * 站点是否关闭。
    */
-  Paused: boolean
+  Paused?: boolean
   /**
    * 是否开启 CNAME 加速，取值有：
 <li> enabled：开启；</li>
 <li> disabled：关闭。</li>
    */
-  CnameSpeedUp: string
+  CnameSpeedUp?: string
   /**
    * CNAME 接入状态，取值有：
 <li> finished：站点已验证；</li>
 <li> pending：站点验证中。</li>
    */
-  CnameStatus: string
+  CnameStatus?: string
   /**
    * 资源标签列表。
    */
-  Tags: Array<Tag>
+  Tags?: Array<Tag>
   /**
    * 计费资源列表。
    */
-  Resources: Array<Resource>
+  Resources?: Array<Resource>
   /**
    * 站点创建时间。
    */
-  CreatedOn: string
+  CreatedOn?: string
   /**
    * 站点修改时间。
    */
-  ModifiedOn: string
+  ModifiedOn?: string
   /**
    * 站点接入地域，取值有：
 <li> global：全球；</li>
 <li> mainland：中国大陆；</li>
 <li> overseas：境外区域。</li>
    */
-  Area: string
+  Area?: string
   /**
    * 用户自定义 NS 信息。
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  VanityNameServers: VanityNameServers
+  VanityNameServers?: VanityNameServers
   /**
    * 用户自定义 NS IP 信息。
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  VanityNameServersIps: Array<VanityNameServersIps>
+  VanityNameServersIps?: Array<VanityNameServersIps>
   /**
    * 展示状态，取值有：
 <li> active：已启用；</li>
 <li> inactive：未生效；</li>
 <li> paused：已停用。</li>
    */
-  ActiveStatus: string
+  ActiveStatus?: string
   /**
    * 站点别名。数字、英文、-和_组合，限制20个字符。
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  AliasZoneName: string
+  AliasZoneName?: string
   /**
    * 是否伪站点，取值有：
 <li> 0：非伪站点；</li>
 <li> 1：伪站点。</li>
    */
-  IsFake: number
+  IsFake?: number
   /**
-   * 锁定状态，取值有：<li> enable：正常，允许进行修改操作；</li><li> disable：锁定中，不允许进行修改操作。</li>
+   * 锁定状态，取值有：<li> enable：正常，允许进行修改操作；</li><li> disable：锁定中，不允许进行修改操作；</li><li> plan_migrate：套餐迁移中，不允许进行修改操作。</li>
    */
   LockStatus?: string
+  /**
+   * 归属权验证信息。
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  OwnershipVerification?: OwnershipVerification
 }
 
 /**
@@ -2353,26 +2411,13 @@ export interface AlgDetectJS {
  */
 export interface AccelerationDomain {
   /**
-   * 源站信息。
-注意：此字段可能返回 null，表示取不到有效值。
-   */
-  OriginDetail?: OriginDetail
-  /**
-   * 创建时间。
+   * 站点 ID。
    */
-  CreatedOn?: string
+  ZoneId?: string
   /**
    * 加速域名名称。
    */
   DomainName?: string
-  /**
-   * 修改时间。
-   */
-  ModifiedOn?: string
-  /**
-   * 站点 ID。
-   */
-  ZoneId?: string
   /**
    * 加速域名状态，取值有：
 <li>online：已生效；</li>
@@ -2382,6 +2427,11 @@ export interface AccelerationDomain {
 <li>init：未生效，待激活站点；</li>
    */
   DomainStatus?: string
+  /**
+   * 源站信息。
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  OriginDetail?: OriginDetail
   /**
    * CNAME 地址。
    */
@@ -2391,6 +2441,19 @@ export interface AccelerationDomain {
 注意：此字段可能返回 null，表示取不到有效值。
    */
   IdentificationStatus?: string
+  /**
+   * 创建时间。
+   */
+  CreatedOn?: string
+  /**
+   * 修改时间。
+   */
+  ModifiedOn?: string
+  /**
+   * 当域名需要进行归属权验证才能继续提供服务时，该对象会携带对应验证方式所需要的信息。
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  OwnershipVerification?: OwnershipVerification
 }
 
 /**
@@ -2833,11 +2896,11 @@ export interface FileAscriptionInfo {
  */
 export interface DescribeAccelerationDomainsResponse {
   /**
-   * 加速域名总数。
+   * 符合查询条件的加速域名个数。
    */
   TotalCount?: number
   /**
-   * 加速域名列表。
+   * 符合查询条件的所有加速域名的信息。
    */
   AccelerationDomains?: Array<AccelerationDomain>
   /**
@@ -3520,34 +3583,47 @@ export interface DDoS {
  */
 export interface CreateZoneRequest {
   /**
-   * 站点名称。
+   * 站点接入类型。该参数取值如下，不填写时默认为 partial：
+<li>partial：CNAME 接入；</li>
+<li> full：NS 接入；</li>
+<li>noDomainAccess：无域名接入。</li>
+   */
+  Type?: string
+  /**
+   * 站点名称。CNAME/NS 接入的时，请传入二级域名（example.com）作为站点名称；无域名接入时，该值请保留为空。
    */
   ZoneName?: string
   /**
-   * 接入方式，取值有：
-<li> full：NS接入；</li>
-<li> partial：CNAME接入，请先调用认证站点API（IdentifyZone）进行站点归属权校验，校验通过后继续调用本接口创建站点；<li>noDomainAccess：无域名接入，取此值时仅Tags字段有效。</li>
-</li>不填写使用默认值full。
+   * Type 取值为 partial/full 时，七层域名的加速区域。以下为该参数取值，不填写时该值默认为 overseas。Type 取值为 noDomainAccess 时该值请保留为空：
+<li> global: 全球可用区；</li>
+<li> mainland: 中国大陆可用区；</li>
+<li> overseas: 全球可用区（不含中国大陆）。</li>
    */
-  Type?: string
+  Area?: string
   /**
-   * 是否跳过站点现有的DNS记录扫描。默认值：false。
+   * 待绑定的目标套餐 ID。当您账号下已存在套餐时，可以填写此参数，直接将站点绑定至该套餐。若您当前没有可绑定的套餐时，请前往控制台购买套餐完成站点创建。
    */
-  JumpStart?: boolean
+  PlanId?: string
+  /**
+   * 同名站点标识。限制输入数字、英文、- 和 _ 组合，长度 20 个字符以内。详情参考 [同名站点标识](https://cloud.tencent.com/document/product/1552/70202)，无此使用场景时，该字段保留为空即可。
+   */
+  AliasZoneName?: string
   /**
-   * 资源标签。
+   * 标签。该参数用于对站点进行分权限管控、分账。需要先前往 [标签控制台](https://console.cloud.tencent.com/tag/taglist) 创建对应的标签才可以在此处传入对应的标签键和标签值。
    */
   Tags?: Array<Tag>
   /**
    * 是否允许重复接入。
 <li> true：允许重复接入；</li>
 <li> false：不允许重复接入。</li>不填写使用默认值false。
+   * @deprecated
    */
   AllowDuplicates?: boolean
   /**
-   * 站点别名。数字、英文、-和_组合，限制20个字符。
+   * 是否跳过站点现有的DNS记录扫描。默认值：false。
+   * @deprecated
    */
-  AliasZoneName?: string
+  JumpStart?: boolean
 }
 
 /**
@@ -3723,6 +3799,26 @@ export interface AscriptionInfo {
   RecordValue: string
 }
 
+/**
+ * VerifyOwnership返回参数结构体
+ */
+export interface VerifyOwnershipResponse {
+  /**
+   * 归属权验证结果。
+<li>success：验证成功；</li>
+<li>fail：验证失败。</li>
+   */
+  Status?: string
+  /**
+   * 当验证结果为不通过时，该字段会返回原因，协助您排查问题。
+   */
+  Result?: string
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
 /**
  * 规则引擎规则详情
  */
@@ -4575,6 +4671,16 @@ export interface VanityNameServersIps {
   IPv4: string
 }
 
+/**
+ * NS 接入，切换 DNS 服务器所需的信息。
+ */
+export interface NsVerification {
+  /**
+   * NS 接入时，分配给用户的 DNS 服务器地址，需要将域名的 NameServer 切换至该地址。
+   */
+  NameServers?: Array<string>
+}
+
 /**
  * 慢速攻击配置。
  */
@@ -5028,6 +5134,11 @@ export interface Filter {
  * CreateAccelerationDomain返回参数结构体
  */
 export interface CreateAccelerationDomainResponse {
+  /**
+   * 当您的站点未进行归属权验证时，您可通过该参数返回的信息单独对域名进行归属权校验。详情参考 [站点/域名归属权验证](https://cloud.tencent.com/document/product/1552/70789)。
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  OwnershipVerification?: OwnershipVerification
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */
@@ -5058,9 +5169,20 @@ export interface DescribeTimingL4DataResponse {
  */
 export interface CreateZoneResponse {
   /**
-   * 站点ID。
+   * 站点 ID。
    */
   ZoneId?: string
+  /**
+   * 站点归属权验证信息。站点完成创建后，您还需要完成归属权校验，站点才能正常服务。
+
+Type = partial 时，您需要参考 [站点/域名归属权验证](https://cloud.tencent.com/document/product/1552/70789) 前往您的域名解析服务商添加 TXT 记录或者前往根域名服务器添加文件，再调用接口 [VerifyOwnership]() 完成验证；
+
+Type = full 时，您需要参考 [修改 DNS 服务器](https://cloud.tencent.com/document/product/1552/90452) 切换 DNS 服务器即可，可通过接口 [VerifyOwnership]() 查询 DNS 是否切换成功；
+
+Type = noDomainAccess 时，该值为空，不需要进行任何操作。
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  OwnershipVerification?: OwnershipVerification
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */
@@ -5592,11 +5714,11 @@ export interface BindZoneToPlanRequest {
  */
 export interface CreateAccelerationDomainRequest {
   /**
-   * 加速域名所属站点ID。
+   * 加速域名所属站点 ID。
    */
   ZoneId: string
   /**
-   * 加速域名名称。
+   * 加速域名。
    */
   DomainName: string
   /**
@@ -5989,11 +6111,11 @@ export interface DescribeZonesResponse {
   /**
    * 符合条件的站点个数。
    */
-  TotalCount: number
+  TotalCount?: number
   /**
-   * 站点详细信息列表。
+   * 站点详细信息。
    */
-  Zones: Array<Zone>
+  Zones?: Array<Zone>
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */
@@ -6533,6 +6655,29 @@ export interface CreateSharedCNAMEResponse {
   RequestId?: string
 }
 
+/**
+ * 该结构体表示各种场景、模式下，用于验证用户对站点域名的归属权内容。
+ */
+export interface OwnershipVerification {
+  /**
+   * CNAME 接入，使用 DNS 解析验证时所需的信息。详情参考 [站点/域名归属权验证
+](https://cloud.tencent.com/document/product/1552/70789#7af6ecf8-afca-4e35-8811-b5797ed1bde5)。
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  DnsVerification?: DnsVerification
+  /**
+   * CNAME 接入，使用文件验证时所需的信息。详情参考 [站点/域名归属权验证
+](https://cloud.tencent.com/document/product/1552/70789#7af6ecf8-afca-4e35-8811-b5797ed1bde5)。
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  FileVerification?: FileVerification
+  /**
+   * NS 接入，切换 DNS 服务器所需的信息。详情参考 [修改 DNS 服务器](https://cloud.tencent.com/document/product/1552/90452)。
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  NsVerification?: NsVerification
+}
+
 /**
  * DescribePurgeTasks返回参数结构体
  */
@@ -6828,46 +6973,45 @@ export interface CreateSharedCNAMERequest {
  */
 export interface DescribeAccelerationDomainsRequest {
   /**
-   * 加速域名所属站点ID。
+   * 加速域名所属站点 ID。
    */
   ZoneId: string
   /**
-   * 过滤条件，Filters.Values的上限为20。详细的过滤条件如下：
-<li>domain-name<br>   按照【<strong>加速域名名称</strong>】进行过滤。<br>   类型：String<br>   必选：否
-<li>origin-type<br>   按照【<strong>源站类型</strong>】进行过滤。<br>   类型：String<br>   必选：否
-<li>origin<br>   按照【<strong>主源站地址</strong>】进行过滤。<br>   类型：String<br>   必选：否
-<li>backup-origin<br>   按照【<strong>备用源站地址</strong>】进行过滤。<br>   类型：String<br>   必选：否
-<li>domain-cname<br>   按照【<strong>加速CNAME名</strong>】进行过滤。<br>   类型：String<br>   必选：否
-<li>share-cname<br>   按照【<strong>共享CNAME名</strong>】进行过滤。<br>   类型：String<br>   必选：否
-   */
-  Filters?: Array<AdvancedFilter>
-  /**
-   * 列表排序方式，取值有：
-<li>asc：升序排列；</li>
-<li>desc：降序排列。</li>默认值为asc。
-   */
-  Direction?: string
-  /**
-   * 匹配方式，取值有：
-<li>all：返回匹配所有查询条件的加速域名；</li>
-<li>any：返回匹配任意一个查询条件的加速域名。</li>默认值为all。
+   * 分页查询偏移量，默认为 0。
    */
-  Match?: string
+  Offset?: number
   /**
    * 分页查询限制数目，默认值：20，上限：200。
    */
   Limit?: number
   /**
-   * 分页查询偏移量，默认为 0。
+   * 过滤条件，Filters.Values 的上限为 20。该参数不填写时，返回当前 zone-id 下所有域名信息。详细的过滤条件如下：
+<li>domain-name：按照加速域名进行过滤；</li>
+<li>origin-type：按照源站类型进行过滤；</li>
+<li>origin：按照主源站地址进行过滤；</li>
+<li>backup-origin： 按照备用源站地址进行过滤；</li>
+<li>domain-cname：按照 CNAME 进行过滤；</li>
+<li>share-cname：按照共享 CNAME 进行过滤；</li>
    */
-  Offset?: number
+  Filters?: Array<AdvancedFilter>
   /**
-   * 排序依据，取值有：
+   * 可根据该字段对返回结果进行排序，取值有：
 <li>created_on：加速域名创建时间；</li>
-<li>domain-name：加速域名名称；</li>
-</li>默认根据domain-name属性排序。
+<li>domain-name：加速域名。</li>不填写时，默认对返回结果按照 domain-name 排序。
    */
   Order?: string
+  /**
+   * 排序方向，如果是字段值为数字，则根据数字大小排序；如果字段值为文本，则根据 ascill 码的大小排序。取值有：
+<li>asc：升序排列；</li>
+<li>desc：降序排列。</li>不填写使用默认值 asc。
+   */
+  Direction?: string
+  /**
+   * 匹配方式，取值有：
+<li>all：返回匹配所有查询条件的加速域名；</li>
+<li>any：返回匹配任意一个查询条件的加速域名。</li>不填写时默认值为 all。
+   */
+  Match?: string
 }
 
 /**