@nocobase/plugin-verification
Version:
User identity verification management, including SMS, TOTP authenticator, with extensibility.
1,723 lines (1,722 loc) • 39.6 kB
TypeScript
/**
* UploadImage返回参数结构体
*/
export interface UploadImageResponse {
/**
* 资质照片地址。
*/
AccessUrl?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RenewDomainBatch返回参数结构体
*/
export interface RenewDomainBatchResponse {
/**
* 操作日志ID。
*/
LogId: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* SyncCustomDnsHost请求参数结构体
*/
export interface SyncCustomDnsHostRequest {
/**
* 域名实例ID
*/
DomainId: string;
}
/**
* BatchModifyDomainInfo请求参数结构体
*/
export interface BatchModifyDomainInfoRequest {
/**
* 批量修改的域名。
*/
Domains: Array<string>;
/**
* 模板ID。
*/
TemplateId: string;
/**
* true： 开启60天内禁止转移注册商锁定
false：关闭60天内禁止转移注册商锁定
默认 true
*/
LockTransfer?: boolean;
}
/**
* 获取域名基础模板信息
*/
export interface DomainSimpleInfo {
/**
* 域名资源ID。
*/
DomainId: string;
/**
* 域名名称。
*/
DomainName: string;
/**
* 域名实名认证状态。
NotUpload：未实名认证
InAudit：实名审核中
Approved：实名审核通过
Reject：实名审核失败
NoAudit: 无需实名认证
*/
RealNameAuditStatus: string;
/**
* 域名实名认证不通过原因。
注意：此字段可能返回 null，表示取不到有效值。
*/
RealNameAuditUnpassReason: string;
/**
* 域名命名审核状态。
NotAudit：命名审核未上传
Pending：命名审核待上传
Auditing：域名命名审核中
Approved：域名命名审核通过
Rejected：域名命名审核拒绝
*/
DomainNameAuditStatus: string;
/**
* 域名命名审核不通过原因。
注意：此字段可能返回 null，表示取不到有效值。
*/
DomainNameAuditUnpassReason: string;
/**
* 注册时间。
*/
CreationDate: string;
/**
* 到期时间
*/
ExpirationDate: string;
/**
* 域名状态。
ok：正常
serverHold：注册局暂停解析
clientHold：注册商暂停解析
pendingTransfer：转移中
renewingPeriod：续费期
redemptionPeriod：偿还期
pendingDelete：删除期
serverTransferProhibited：注册局禁止转移
serverUpdateProhibited：注册局禁止更新
serverDeleteProhibited：注册局禁止删除
clientTransferProhibited：注册商禁止转移
clientUpdateProhibited：注册商禁止更新
clientDeleteProhibited：注册商禁止删除
serverRenewProhibited: 注册局禁止续费
clientRenewProhobited: 注册商禁止续费
*/
DomainStatus: Array<string>;
/**
* 域名购买状态。
ok：正常
RegisterPending：待注册
RegisterDoing：注册中
RegisterFailed：注册失败
AboutToExpire: 即将过期
RenewPending：已进入续费期，需要进行续费
RenewDoing：续费中
RedemptionPending：已进入赎回期，需要进行续费
RedemptionDoing：赎回中
TransferPending：待转入中
TransferTransing：转入中
TransferFailed：转入失败
*/
BuyStatus: string;
/**
* 注册商类型
epp: DNSPod, Inc.（烟台帝思普网络科技有限公司）
qcloud: Tencent Cloud Computing (Beijing) Limited Liability Company（腾讯云计算（北京）有限责任公司）
yunxun: Guangzhou Yunxun Information Technology Co., Ltd.（广州云讯信息科技有限公司）
xinnet: Xin Net Technology Corporation（北京新网数码信息技术有限公司）
*/
RegistrarType: string;
/**
* 域名绑定的ns
*/
NameServer: Array<string>;
/**
* true：开启锁定
false：关闭锁定
*/
LockTransfer: boolean;
/**
* 锁定结束时间
*/
LockEndTime: string;
/**
* 认证类型：I=个人，E=企业
*/
RegistrantType: string;
/**
* 域名所有者，中文
*/
OrganizationNameCN: string;
/**
* 域名所有者，英文
*/
OrganizationName: string;
/**
* 域名联系人，中文
*/
RegistrantNameCN: string;
/**
* 域名联系人，英文
*/
RegistrantName: string;
}
/**
* CreateDomainRedemption返回参数结构体
*/
export interface CreateDomainRedemptionResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UpdateProhibitionBatch请求参数结构体
*/
export interface UpdateProhibitionBatchRequest {
/**
* 批量操作的域名。
*/
Domains: Array<string>;
/**
* 是否开启禁止域名更新。
True:开启禁止域名更新状态。
False：关闭禁止域名更新状态。
*/
Status: boolean;
}
/**
* TransferInDomainBatch返回参数结构体
*/
export interface TransferInDomainBatchResponse {
/**
* 日志ID
*/
LogId: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteTemplate返回参数结构体
*/
export interface DeleteTemplateResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* TransferInDomainBatch请求参数结构体
*/
export interface TransferInDomainBatchRequest {
/**
* 转入的域名名称数组。
*/
Domains: Array<string>;
/**
* 域名转移码数组。
*/
PassWords: Array<string>;
/**
* 模板ID。
*/
TemplateId: string;
/**
* 付费模式 0手动在线付费，1使用余额付费。
*/
PayMode: number;
/**
* 自动续费开关。有两个可选值：
0 表示关闭，不自动续费（默认值）
1 表示开启，将自动续费
*/
AutoRenewFlag?: number;
/**
* true： 开启60天内禁止转移注册商锁定
false：关闭60天内禁止转移注册商锁定
默认 true
*/
LockTransfer?: boolean;
/**
* 是否开启更新锁：0=默认不开启，1=开启
*/
UpdateProhibition?: number;
/**
* 是否开启转移锁：0=默认不开启，1=开启
*/
TransferProhibition?: number;
/**
* 渠道来源，pc/miniprogram/h5等
*/
ChannelFrom?: string;
/**
* 订单来源，common正常/dianshi_active点石活动等
*/
OrderFrom?: string;
/**
* 活动id
*/
ActivityId?: string;
}
/**
* CreateDomainBatch返回参数结构体
*/
export interface CreateDomainBatchResponse {
/**
* 批量日志ID
注意：此字段可能返回 null，表示取不到有效值。
*/
LogId?: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 批量操作日志详情
*/
export interface DomainBatchDetailSet {
/**
* 详情ID
*/
Id: number;
/**
* 类型 new: 注册域名 batch_transfer_prohibition_on:开启禁止转移 batch_transfer_prohibition_off:关闭禁止转移 batch_update_prohibition_on:开启禁止更新 batch_update_prohibition_off:关闭禁止更新
*/
Action: string;
/**
* 域名
*/
Domain: string;
/**
* 执行状态：
doing 执行中。
failed 操作失败。
success 操作成功。
*/
Status: string;
/**
* 失败原因
注意：此字段可能返回 null，表示取不到有效值。
*/
Reason: string;
/**
* 创建时间
*/
CreatedOn: string;
/**
* 更新时间
*/
UpdatedOn: string;
/**
* 订单号
注意：此字段可能返回 null，表示取不到有效值。
*/
BigDealId?: string;
}
/**
* SendPhoneEmailCode返回参数结构体
*/
export interface SendPhoneEmailCodeResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyDomainDNSBatch返回参数结构体
*/
export interface ModifyDomainDNSBatchResponse {
/**
* 日志ID。
*/
LogId: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCustomDnsHostSet返回参数结构体
*/
export interface DescribeCustomDnsHostSetResponse {
/**
* 自定义DNS Host 列表
注意：此字段可能返回 null，表示取不到有效值。
*/
DnsHostSet?: Array<CustomDnsHost>;
/**
* 自定义DNS Host总数
*/
TotalCount?: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeletePhoneEmail请求参数结构体
*/
export interface DeletePhoneEmailRequest {
/**
* 手机或者邮箱
*/
Code: string;
/**
* 1：手机 2：邮箱
*/
Type: number;
}
/**
* DescribeTemplate返回参数结构体
*/
export interface DescribeTemplateResponse {
/**
* 模板信息
*/
Template?: TemplateInfo;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 自定义DNS Host
*/
export interface CustomDnsHost {
/**
* DNS名称
*/
DnsName: string;
/**
* IP地址列表
*/
IpSet: Array<string>;
}
/**
* CheckDomain返回参数结构体
*/
export interface CheckDomainResponse {
/**
* 所查询域名名称
*/
DomainName?: string;
/**
* 是否能够注册
*/
Available?: boolean;
/**
* 不能注册原因
*/
Reason?: string;
/**
* 是否是溢价词
*/
Premium?: boolean;
/**
* 域名价格
*/
Price?: number;
/**
* 是否是敏感词
*/
BlackWord?: boolean;
/**
* 溢价词描述
注意：此字段可能返回 null，表示取不到有效值。
*/
Describe?: string;
/**
* 溢价词的续费价格
注意：此字段可能返回 null，表示取不到有效值。
*/
FeeRenew?: number;
/**
* 域名真实价格, 溢价词时价格跟年限有关，非溢价词时价格为1年的价格
注意：此字段可能返回 null，表示取不到有效值。
*/
RealPrice?: number;
/**
* 溢价词的转入价格
注意：此字段可能返回 null，表示取不到有效值。
*/
FeeTransfer?: number;
/**
* 溢价词的赎回价格
*/
FeeRestore?: number;
/**
* 检测年限
*/
Period?: number;
/**
* 是否支持北京备案 true 支持 false 不支持
*/
RecordSupport?: boolean;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDomainSimpleInfo请求参数结构体
*/
export interface DescribeDomainSimpleInfoRequest {
/**
* 域名
*/
DomainName: string;
}
/**
* CreatePhoneEmail请求参数结构体
*/
export interface CreatePhoneEmailRequest {
/**
* 手机号或者邮箱
*/
Code: string;
/**
* 1：手机 2：邮箱
*/
Type: number;
/**
* 验证码
*/
VerifyCode: string;
}
/**
* DeleteCustomDnsHost返回参数结构体
*/
export interface DeleteCustomDnsHostResponse {
/**
* 异步任务ID
*/
LogId: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 域名价格信息
*/
export interface PriceInfo {
/**
* 域名后缀，例如.com
*/
Tld: string;
/**
* 购买年限，范围[1-10]
*/
Year: number;
/**
* 域名原价
*/
Price: number;
/**
* 域名现价
*/
RealPrice: number;
/**
* 商品的购买类型，新购，续费，赎回，转入，续费并转入
*/
Operation: string;
}
/**
* DescribeTemplate请求参数结构体
*/
export interface DescribeTemplateRequest {
/**
* 模板ID
*/
TemplateId: string;
}
/**
* RenewDomainBatch请求参数结构体
*/
export interface RenewDomainBatchRequest {
/**
* 域名续费的年限。
*/
Period: number;
/**
* 批量续费的域名。
*/
Domains: Array<string>;
/**
* 付费模式 0手动在线付费，1使用余额付费，2使用特惠包。
*/
PayMode: number;
/**
* 自动续费开关。有三个可选值：
0 表示关闭，不自动续费
1 表示开启，将自动续费
2 表示不处理，保留域名原有状态（默认值）
*/
AutoRenewFlag?: number;
/**
* 特惠包ID
*/
PackageResourceId?: string;
/**
* 渠道来源，pc/miniprogram/h5等
*/
ChannelFrom?: string;
/**
* 订单来源，common正常/dianshi_active点石活动等
*/
OrderFrom?: string;
/**
* 活动id
*/
ActivityId?: string;
}
/**
* BatchModifyDomainInfo返回参数结构体
*/
export interface BatchModifyDomainInfoResponse {
/**
* 日志ID
*/
LogId: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyDomainOwnerBatch返回参数结构体
*/
export interface ModifyDomainOwnerBatchResponse {
/**
* 日志id
*/
LogId: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* Template数据
*/
export interface TemplateInfo {
/**
* 模板ID
*/
TemplateId?: string;
/**
* 认证状态：未实名认证:NotUpload, 实名审核中:InAudit，已实名认证:Approved，实名审核失败:Reject
*/
AuditStatus?: string;
/**
* 创建时间
*/
CreatedOn?: string;
/**
* 更新时间
*/
UpdatedOn?: string;
/**
* 用户UIN
*/
UserUin?: string;
/**
* 是否是默认模板: 是:yes，否:no
*/
IsDefault?: string;
/**
* 认证失败原因
*/
AuditReason?: string;
/**
* 认证信息
*/
CertificateInfo?: CertificateInfo;
/**
* 联系人信息
*/
ContactInfo?: ContactInfo;
/**
* 模板是否符合规范， 1是 0 否
*/
IsValidTemplate?: number;
/**
* 不符合规范原因
*/
InvalidReason?: string;
/**
* 是包含黑名单手机或邮箱
*/
IsBlack?: boolean;
}
/**
* DescribeDomainBaseInfo返回参数结构体
*/
export interface DescribeDomainBaseInfoResponse {
/**
* 域名信息
*/
DomainInfo?: DomainBaseInfo;
/**
* 用户Uin
注意：此字段可能返回 null，表示取不到有效值。
*/
Uin?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeTemplateList返回参数结构体
*/
export interface DescribeTemplateListResponse {
/**
* 模板数量。
*/
TotalCount?: number;
/**
* 模板详细信息列表。
*/
TemplateSet?: Array<TemplateInfo>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* TransferProhibitionBatch请求参数结构体
*/
export interface TransferProhibitionBatchRequest {
/**
* 批量操作的域名。
*/
Domains: Array<string>;
/**
* 是否开启禁止域名转移。
True: 开启禁止域名转移状态。
False：关闭禁止域名转移状态。
*/
Status: boolean;
}
/**
* DescribeTemplateList请求参数结构体
*/
export interface DescribeTemplateListRequest {
/**
* 偏移量，默认为0。
*/
Offset?: number;
/**
* 返回数量，默认为20，最大值为100。
*/
Limit?: number;
/**
* 用户注册类型，默认:all , 个人：I ,企业: E
*/
Type?: string;
/**
* 认证状态：未实名审核:NotUpload, 实名审核中:InAudit，已实名审核:Approved，实名审核失败:Reject，更新手机邮箱:NotVerified。
*/
Status?: string;
/**
* 关键字，用于域名所有者筛选
*/
Keyword?: string;
}
/**
* UpdateProhibitionBatch返回参数结构体
*/
export interface UpdateProhibitionBatchResponse {
/**
* 日志ID
*/
LogId: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeBatchOperationLogDetails请求参数结构体
*/
export interface DescribeBatchOperationLogDetailsRequest {
/**
* 日志ID。
*/
LogId: number;
/**
* 偏移量，默认为0。
*/
Offset?: number;
/**
* 返回数量，默认为20，最大值为200。
*/
Limit?: number;
}
/**
* DescribeCustomDnsHostSet请求参数结构体
*/
export interface DescribeCustomDnsHostSetRequest {
/**
* 域名实例ID
*/
DomainId: string;
/**
* 返回数量，默认为20，取值范围[1,100]
*/
Limit: number;
/**
* 偏移量，默认为0
*/
Offset: number;
}
/**
* CreateCustomDnsHost返回参数结构体
*/
export interface CreateCustomDnsHostResponse {
/**
* 异步任务ID
*/
LogId: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 域名联系人信息
*/
export interface ContactInfo {
/**
* 注册人（中文）
*/
OrganizationNameCN: string;
/**
* 注册人（英文）
*/
OrganizationName: string;
/**
* 联系人（中文）
*/
RegistrantNameCN: string;
/**
* 联系人（英文）
*/
RegistrantName: string;
/**
* 省份（中文）
*/
ProvinceCN: string;
/**
* 城市（中文）
*/
CityCN: string;
/**
* 街道（中文）
*/
StreetCN: string;
/**
* 街道（英文）
*/
Street: string;
/**
* 国家（中文）
*/
CountryCN: string;
/**
* 联系人手机号
*/
Telephone: string;
/**
* 联系人邮箱
*/
Email: string;
/**
* 邮编
*/
ZipCode: string;
/**
* 用户类型 E:组织， I:个人
*/
RegistrantType: string;
/**
* 省份（英文）。作为入参时可以不填
*/
Province?: string;
/**
* 城市（英文）。作为入参时可以不填
*/
City?: string;
/**
* 国家（英文）。作为入参时可以不填
*/
Country?: string;
}
/**
* DescribeDomainPriceList返回参数结构体
*/
export interface DescribeDomainPriceListResponse {
/**
* 域名价格列表
*/
PriceList?: Array<PriceInfo>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateTemplate返回参数结构体
*/
export interface CreateTemplateResponse {
/**
* 模板信息
*/
Template?: TemplateInfo;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 认证资料信息
*/
export interface CertificateInfo {
/**
* 证件号码。
*/
CertificateCode: string;
/**
* 证件类型。
SFZ: 身份证。
HZ: 护照。
TXZ: 中国港澳居民来往内地通行证。
TWSFZ: 中国台湾居民来往大陆通行证。
GWSFZ: 外国人永久居留身份证。
ORG: 组织机构代码证
YYZZ: 工商营业执照。
TYDMZ: 统一社会信用代码证书。
BDDH: 部队代号
JDXKZ: 军队单位对外有偿服务许可证。
SYZS: 事业单位法定代表人证书。
GWCZDJZ: 外国企业常驻代表机构登记证。
STDJZ: 社会团体法定代表人登记证书。
ZJDJZ: 宗教活动场所登记证。
MBDJZ: 民办非企业单位登记证书。
JJDJZ: 基金会法定代表人登记证书。
LSXKZ: 律师事务所执业许可证。
GWZHDJZ: 外国在华文化中心登记证。
GWLYDJZ: 外国政府旅游部门常驻代表机构批准登记证。
SFXKZ: 司法鉴定许可证
GWJGZJ: 外国机构证件。
SHFWJGZ: 社会服务机构登记证书。
MBXXXKZ: 民办学校办学许可证。
YLJGXKZ: 医疗机构执业许可证。
GAJZZ: 中国港澳居住证。
TWJZZ: 中国台湾居住证。
QTTYDM: 其他-统一社会信用代码证书。
GZJGZY: 公证机构执业证。
*/
CertificateType: string;
/**
* 证件照片地址。
*/
ImgUrl: string;
/**
* 原始照片地址
注意：此字段可能返回 null，表示取不到有效值。
*/
OriginImgUrl?: string;
/**
* 联系人证件号码。
注意：此字段可能返回 null，表示取不到有效值。
*/
RegistrantCertificateCode?: string;
/**
* 联系人证件类型。
SFZ: 身份证。
HZ: 护照。
TXZ: 中国港澳居民来往内地通行证。
TWSFZ: 中国台湾居民来往大陆通行证。
GWSFZ: 外国人永久居留身份证。
ORG: 组织机构代码证
YYZZ: 工商营业执照。
TYDMZ: 统一社会信用代码证书。
BDDH: 部队代号
JDXKZ: 军队单位对外有偿服务许可证。
SYZS: 事业单位法定代表人证书。
GWCZDJZ: 外国企业常驻代表机构登记证。
STDJZ: 社会团体法定代表人登记证书。
ZJDJZ: 宗教活动场所登记证。
MBDJZ: 民办非企业单位登记证书。
JJDJZ: 基金会法定代表人登记证书。
LSXKZ: 律师事务所执业许可证。
GWZHDJZ: 外国在华文化中心登记证。
GWLYDJZ: 外国政府旅游部门常驻代表机构批准登记证。
SFXKZ: 司法鉴定许可证
GWJGZJ: 外国机构证件。
SHFWJGZ: 社会服务机构登记证书。
MBXXXKZ: 民办学校办学许可证。
YLJGXKZ: 医疗机构执业许可证。
GAJZZ: 中国港澳居住证。
TWJZZ: 中国台湾居住证。
QTTYDM: 其他-统一社会信用代码证书。
GZJGZY: 公证机构执业证。
注意：此字段可能返回 null，表示取不到有效值。
*/
RegistrantCertificateType?: string;
/**
* 联系人证件照片地址。
注意：此字段可能返回 null，表示取不到有效值。
*/
RegistrantImgUrl?: string;
}
/**
* DeleteTemplate请求参数结构体
*/
export interface DeleteTemplateRequest {
/**
* 模板ID
*/
TemplateId: string;
}
/**
* CheckBatchStatus请求参数结构体
*/
export interface CheckBatchStatusRequest {
/**
* 操作日志 ID数组，最多 200 个
*/
LogIds: Array<number | bigint>;
}
/**
* SetDomainAutoRenew返回参数结构体
*/
export interface SetDomainAutoRenewResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateTemplate请求参数结构体
*/
export interface CreateTemplateRequest {
/**
* 联系人信息
*/
ContactInfo: ContactInfo;
/**
* 证件信息
*/
CertificateInfo?: CertificateInfo;
}
/**
* 批量任务状态
*/
export interface BatchStatus {
/**
* 批量任务id
*/
LogId: number;
/**
* 批量任务状态 doing：进行中 success：成功 failed：失败 partial_success：部分成功
*/
Status: string;
/**
* 批量任务类型
*/
BatchAction: string;
}
/**
* 域名列表
*/
export interface DomainList {
/**
* 是否是溢价域名：
ture 是
false 不是
*/
IsPremium: boolean;
/**
* 域名资源ID。
*/
DomainId: string;
/**
* 域名名称。
*/
DomainName: string;
/**
* 是否已设置自动续费 。
0：未设置
1：已设置
2：设置后，关闭
*/
AutoRenew: number;
/**
* 注册时间。
*/
CreationDate: string;
/**
* 到期时间。
*/
ExpirationDate: string;
/**
* 域名后缀
*/
Tld: string;
/**
* 编码后的后缀（中文会进行编码）
*/
CodeTld: string;
/**
* 域名购买状态。
ok：正常
AboutToExpire: 即将到期
RegisterPending：注册中
RegisterDoing：注册中
RegisterFailed：注册失败
RenewPending：续费期
RenewDoing：续费中
RedemptionPending：赎回期
RedemptionDoing：赎回中
TransferPending：转入中
TransferTransing：转入中
TransferFailed：转入失败
*/
BuyStatus: string;
}
/**
* DescribeDomainPriceList请求参数结构体
*/
export interface DescribeDomainPriceListRequest {
/**
* 查询价格的后缀列表。默认则为全部后缀
*/
TldList?: Array<string>;
/**
* 查询购买的年份，默认会列出所有年份的价格
*/
Year?: Array<number | bigint>;
/**
* 域名的购买类型：new 新购，renew 续费，redem 赎回，tran 转入
*/
Operation?: Array<string>;
}
/**
* SetDomainAutoRenew请求参数结构体
*/
export interface SetDomainAutoRenewRequest {
/**
* 域名ID 例如：domain-123abc
*/
DomainId: string;
/**
* AutoRenew 有三个可选值：
0：不设置自动续费
1：设置自动续费
2：设置到期后不续费
*/
AutoRenew: number;
}
/**
* CreateDomainBatch请求参数结构体
*/
export interface CreateDomainBatchRequest {
/**
* 模板ID。详情请查看：[获取模板列表](https://cloud.tencent.com/document/product/242/48940)
*/
TemplateId: string;
/**
* 购买域名的年限，可选值：[1-10]
*/
Period: number;
/**
* 批量购买的域名,最多为4000个
*/
Domains: Array<string>;
/**
* 付费模式 0手动在线付费，1使用余额付费，2使用特惠包
*/
PayMode: number;
/**
* 自动续费开关。有两个可选值：
0 表示关闭，不自动续费（默认值）
1 表示开启，将自动续费
*/
AutoRenewFlag?: number;
/**
* 使用的特惠包ID，PayMode为2时必填
*/
PackageResourceId?: string;
/**
* 是否开启更新锁：0=默认不开启，1=开启
*/
UpdateProhibition?: number;
/**
* 是否开启转移锁：0=默认不开启，1=开启
*/
TransferProhibition?: number;
/**
* 渠道来源，pc/miniprogram/h5等
*/
ChannelFrom?: string;
/**
* 订单来源，common正常/dianshi_active点石活动等
*/
OrderFrom?: string;
/**
* 活动id
*/
ActivityId?: string;
}
/**
* ModifyIntlCustomDnsHost请求参数结构体
*/
export interface ModifyIntlCustomDnsHostRequest {
/**
* 域名ID
*/
DomainId: string;
/**
* DNS Host
*/
DnsName: string;
/**
* IP地址
*/
IpSet: Array<string>;
}
/**
* DescribeDomainSimpleInfo返回参数结构体
*/
export interface DescribeDomainSimpleInfoResponse {
/**
* 域名信息
*/
DomainInfo?: DomainSimpleInfo;
/**
* 账号ID
*/
Uin?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDomainBaseInfo请求参数结构体
*/
export interface DescribeDomainBaseInfoRequest {
/**
* 域名
*/
Domain: string;
}
/**
* DescribePhoneEmailList请求参数结构体
*/
export interface DescribePhoneEmailListRequest {
/**
* 0：所有类型 1：手机 2：邮箱，默认0
*/
Type?: number;
/**
* 偏移量，默认为0
*/
Offset?: number;
/**
* 返回数量，默认为20，取值范围[1,200]
*/
Limit?: number;
/**
* 手机或者邮箱，用于精确搜索
*/
Code?: string;
}
/**
* 获取域名基础信息
*/
export interface DomainBaseInfo {
/**
* 域名资源ID。
*/
DomainId: string;
/**
* 域名名称。
*/
DomainName: string;
/**
* 域名实名认证状态。
NotUpload：未实名认证
InAudit：实名审核中
Approved：实名审核通过
Reject：实名审核失败
NoAudit: 无需实名认证
*/
RealNameAuditStatus: string;
/**
* 域名实名认证不通过原因。
注意：此字段可能返回 null，表示取不到有效值。
*/
RealNameAuditUnpassReason: string;
/**
* 域名命名审核状态。
NotAudit：命名审核未上传
Pending：命名审核待上传
Auditing：域名命名审核中
Approved：域名命名审核通过
Rejected：域名命名审核拒绝
*/
DomainNameAuditStatus: string;
/**
* 域名命名审核不通过原因。
注意：此字段可能返回 null，表示取不到有效值。
*/
DomainNameAuditUnpassReason: string;
/**
* 注册时间。
*/
CreationDate: string;
/**
* 到期时间
*/
ExpirationDate: string;
/**
* 域名状态。
ok：正常
serverHold：注册局暂停解析
clientHold：注册商暂停解析
pendingTransfer：转移中
renewingPeriod：续费期
redemptionPeriod：偿还期
pendingDelete：删除期
serverTransferProhibited：注册局禁止转移
serverUpdateProhibited：注册局禁止更新
serverDeleteProhibited：注册局禁止删除
clientTransferProhibited：注册商禁止转移
clientUpdateProhibited：注册商禁止更新
clientDeleteProhibited：注册商禁止删除
serverRenewProhibited: 注册局禁止续费
clientRenewProhobited: 注册商禁止续费
*/
DomainStatus: Array<string>;
/**
* 域名购买状态。
ok：正常
RegisterPending：待注册
RegisterDoing：注册中
RegisterFailed：注册失败
AboutToExpire: 即将过期
RenewPending：已进入续费期，需要进行续费
RenewDoing：续费中
RedemptionPending：已进入赎回期，需要进行续费
RedemptionDoing：赎回中
TransferPending：待转入中
TransferTransing：转入中
TransferFailed：转入失败
*/
BuyStatus: string;
/**
* 注册商类型
epp: DNSPod, Inc.（烟台帝思普网络科技有限公司）
qcloud: Tencent Cloud Computing (Beijing) Limited Liability Company（腾讯云计算（北京）有限责任公司）
yunxun: Guangzhou Yunxun Information Technology Co., Ltd.（广州云讯信息科技有限公司）
xinnet: Xin Net Technology Corporation（北京新网数码信息技术有限公司）
*/
RegistrarType: string;
/**
* 域名绑定的ns
*/
NameServer: Array<string>;
/**
* true：开启锁定
false：关闭锁定
*/
LockTransfer: boolean;
/**
* 锁定结束时间
*/
LockEndTime: string;
}
/**
* DescribeDomainNameList返回参数结构体
*/
export interface DescribeDomainNameListResponse {
/**
* 域名信息集合
注意：此字段可能返回 null，表示取不到有效值。
*/
DomainSet?: Array<DomainList>;
/**
* 域名总数量
*/
TotalCount?: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDomainNameList请求参数结构体
*/
export interface DescribeDomainNameListRequest {
/**
* 偏移量，默认为0
*/
Offset?: number;
/**
* 返回数量，默认为20，取值范围[1,100]
*/
Limit?: number;
}
/**
* DescribeBatchOperationLogs请求参数结构体
*/
export interface DescribeBatchOperationLogsRequest {
/**
* 偏移量，默认为0。
*/
Offset?: number;
/**
* 返回数量，默认为20，最大值为200。
*/
Limit?: number;
}
/**
* UploadImage请求参数结构体
*/
export interface UploadImageRequest {
/**
* 资质照片，照片的base64编码。
*/
ImageFile: string;
}
/**
* CheckDomain请求参数结构体
*/
export interface CheckDomainRequest {
/**
* 所查询域名名称
*/
DomainName: string;
/**
* 年限。该参数为空时无法查询溢价词域名
*/
Period?: string;
}
/**
* DescribeBatchOperationLogs返回参数结构体
*/
export interface DescribeBatchOperationLogsResponse {
/**
* 总数量
*/
TotalCount?: number;
/**
* 日志列表
注意：此字段可能返回 null，表示取不到有效值。
*/
DomainBatchLogSet?: Array<DomainBatchLogSet>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* TransferProhibitionBatch返回参数结构体
*/
export interface TransferProhibitionBatchResponse {
/**
* 日志ID
*/
LogId: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyCustomDnsHost返回参数结构体
*/
export interface ModifyCustomDnsHostResponse {
/**
* 异步任务ID
*/
LogId: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* SyncCustomDnsHost返回参数结构体
*/
export interface SyncCustomDnsHostResponse {
/**
* 异步任务ID
*/
LogId: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyCustomDnsHost请求参数结构体
*/
export interface ModifyCustomDnsHostRequest {
/**
* 域名实例ID
*/
DomainId: string;
/**
* DNS名称
*/
DnsName: string;
/**
* IP地址列表
*/
IpSet: Array<string>;
}
/**
* CreateCustomDnsHost请求参数结构体
*/
export interface CreateCustomDnsHostRequest {
/**
* 域名实例ID
*/
DomainId: string;
/**
* Dns名称
*/
DnsName: string;
/**
* IP地址列表
*/
IpSet: Array<string>;
}
/**
* ModifyDomainDNSBatch请求参数结构体
*/
export interface ModifyDomainDNSBatchRequest {
/**
* 批量操作的域名。
*/
Domains: Array<string>;
/**
* 域名DNS 数组。
*/
Dns: Array<string>;
}
/**
* DeleteCustomDnsHost请求参数结构体
*/
export interface DeleteCustomDnsHostRequest {
/**
* 域名实例ID
*/
DomainId: string;
/**
* DNS名称
*/
DnsName: string;
}
/**
* DescribeBatchOperationLogDetails返回参数结构体
*/
export interface DescribeBatchOperationLogDetailsResponse {
/**
* 总数量。
*/
TotalCount?: number;
/**
* 日志详情列表。
注意：此字段可能返回 null，表示取不到有效值。
*/
DomainBatchDetailSet?: Array<DomainBatchDetailSet>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* SendPhoneEmailCode请求参数结构体
*/
export interface SendPhoneEmailCodeRequest {
/**
* 手机或者邮箱号。
*/
Code: string;
/**
* 1：手机 2：邮箱。
*/
Type: number;
}
/**
* DescribePhoneEmailList返回参数结构体
*/
export interface DescribePhoneEmailListResponse {
/**
* 手机或者邮箱列表
*/
PhoneEmailList?: Array<PhoneEmailData>;
/**
* 总数量。
*/
TotalCount?: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CheckBatchStatus返回参数结构体
*/
export interface CheckBatchStatusResponse {
/**
* 批量任务状态集
*/
StatusSet?: Array<BatchStatus>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeletePhoneEmail返回参数结构体
*/
export interface DeletePhoneEmailResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateDomainRedemption请求参数结构体
*/
export interface CreateDomainRedemptionRequest {
/**
* 域名 ID
*/
DomainId: string;
}
/**
* CreatePhoneEmail返回参数结构体
*/
export interface CreatePhoneEmailResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 手机号邮箱列表
*/
export interface PhoneEmailData {
/**
* 手机号或者邮箱
*/
Code: string;
/**
* 1：手机 2：邮箱
*/
Type: number;
/**
* 创建时间
*/
CreatedOn: string;
/**
* 1=控制台校验，2=第三方校验
*/
CheckStatus: number;
}
/**
* ModifyDomainOwnerBatch请求参数结构体
*/
export interface ModifyDomainOwnerBatchRequest {
/**
* 要过户的域名。
*/
Domains: Array<string>;
/**
* 转入账户的uin。
*/
NewOwnerUin: string;
/**
* 是否同时转移对应的 DNS 解析域名，默认false
*/
TransferDns?: boolean;
/**
* 转入账户的appid。
*/
NewOwnerAppId?: string;
}
/**
* ModifyIntlCustomDnsHost返回参数结构体
*/
export interface ModifyIntlCustomDnsHostResponse {
/**
* 任务ID
*/
LogId?: number;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 批量操作记录
*/
export interface DomainBatchLogSet {
/**
* 日志ID
*/
LogId: number;
/**
* 数量
*/
Number: number;
/**
* 执行状态：
doing 执行中。
done 执行完成。
*/
Status: string;
/**
* 提交时间
*/
CreatedOn: string;
/**
* 批量操作成功个数
*/
Success?: number;
/**
* 批量操作处理中个数
*/
Doing?: number;
/**
* 批量操作失败个数
*/
Failed?: number;
}