tencentcloud-sdk-nodejs/tencentcloud/services/btoe/v20210514/btoe_models.d.ts

腾讯云 API NODEJS SDK

/**
 * GetDepositFile返回参数结构体
 */
export interface GetDepositFileResponse {
    /**
     * 存证编号
     */
    EvidenceId?: string;
    /**
     * 存证文件临时链接
     */
    EvidenceFile?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateImageDeposit请求参数结构体
 */
export interface CreateImageDepositRequest {
    /**
     * 存证名称(长度最大30)
     */
    EvidenceName: string;
    /**
     * 数据Base64编码，大小不超过5M
     */
    FileContent: string;
    /**
     * 带后缀的文件名称，如 test.png
     */
    FileName: string;
    /**
     * 文件hash
     */
    EvidenceHash: string;
    /**
     * 业务ID 透传 长度最大不超过64
     */
    BusinessId?: string;
    /**
     * 算法类型 0 SM3, 1 SHA256, 2 SHA384 默认0
     */
    HashType?: number;
    /**
     * 存证描述
     */
    EvidenceDescription?: string;
}
/**
 * CreateVideoDeposit请求参数结构体
 */
export interface CreateVideoDepositRequest {
    /**
     * 存证名称(长度最大30)
     */
    EvidenceName: string;
    /**
     * 数据Base64编码，大小不超过5M
     */
    FileContent: string;
    /**
     * 带后缀的文件名称，如music.mkv
     */
    FileName: string;
    /**
     * 文件hash
     */
    EvidenceHash: string;
    /**
     * 业务ID 透传 长度最大不超过64
     */
    BusinessId?: string;
    /**
     * 算法类型 0 SM3, 1 SHA256, 2 SHA384 默认0
     */
    HashType?: number;
    /**
     * 存证描述
     */
    EvidenceDescription?: string;
}
/**
 * CreateDocDeposit请求参数结构体
 */
export interface CreateDocDepositRequest {
    /**
     * 存证名称(长度最大30)
     */
    EvidenceName: string;
    /**
     * 数据Base64编码，大小不超过5M
     */
    FileContent: string;
    /**
     * 带后缀的文件名称，如 test.doc
     */
    FileName: string;
    /**
     * 文件hash
     */
    EvidenceHash: string;
    /**
     * 业务ID 透传 长度最大不超过64
     */
    BusinessId?: string;
    /**
     * 算法类型 0 SM3, 1 SHA256, 2 SHA384 默认0
     */
    HashType?: number;
    /**
     * 存证描述
     */
    EvidenceDescription?: string;
}
/**
 * CreateHashDepositNoSeal请求参数结构体
 */
export interface CreateHashDepositNoSealRequest {
    /**
     * 数据hash
     */
    EvidenceHash: string;
    /**
     * 该字段为透传字段，方便调用方做业务处理， 长度最大不超过64
     */
    BusinessId?: string;
    /**
     * 业务扩展信息
     */
    EvidenceInfo?: string;
}
/**
 * CreateHashDeposit请求参数结构体
 */
export interface CreateHashDepositRequest {
    /**
     * 存证名称(长度最大30)
     */
    EvidenceName: string;
    /**
     * 数据hash
     */
    EvidenceHash: string;
    /**
     * 该字段为透传字段，方便调用方做业务处理， 长度最大不超过64
     */
    BusinessId?: string;
    /**
     * 存证描述
     */
    EvidenceDescription?: string;
}
/**
 * VerifyEvidenceHash返回参数结构体
 */
export interface VerifyEvidenceHashResponse {
    /**
     * 核验结果，true为核验成功，false为核验失败
     */
    Result: boolean;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateDataDeposit返回参数结构体
 */
export interface CreateDataDepositResponse {
    /**
     * 业务ID 透传 长度最大不超过64
  注意：此字段可能返回 null，表示取不到有效值。
     */
    BusinessId: string;
    /**
     * 请求成功，返回存证编码,用于查询存证后续业务数据
     */
    EvidenceId: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * GetDepositCert请求参数结构体
 */
export interface GetDepositCertRequest {
    /**
     * 存证编码
     */
    EvidenceId: string;
}
/**
 * CreateAudioDeposit请求参数结构体
 */
export interface CreateAudioDepositRequest {
    /**
     * 存证名称(长度最大30)
     */
    EvidenceName: string;
    /**
     * 数据Base64编码，大小不超过5M
     */
    FileContent: string;
    /**
     * 带后缀的文件名称，如music.mp3
     */
    FileName: string;
    /**
     * 文件hash
     */
    EvidenceHash: string;
    /**
     * 业务ID 透传 长度最大不超过64
     */
    BusinessId?: string;
    /**
     * 算法类型 0 SM3, 1 SHA256, 2 SHA384 默认0
     */
    HashType?: number;
    /**
     * 存证描述
     */
    EvidenceDescription?: string;
}
/**
 * GetDepositFile请求参数结构体
 */
export interface GetDepositFileRequest {
    /**
     * 存证编码
     */
    EvidenceId: string;
}
/**
 * VerifyEvidenceBlockChainTxHash请求参数结构体
 */
export interface VerifyEvidenceBlockChainTxHashRequest {
    /**
     * 区块链交易 hash，在“存证基本信息查询（GetDepositInfo）”接口中可以获取。
     */
    EvidenceTxHash: string;
}
/**
 * VerifyEvidenceHash请求参数结构体
 */
export interface VerifyEvidenceHashRequest {
    /**
     * 存证内容hash，hash类型即为用户在存证时所用或所选的hash类型
     */
    EvidenceHash: string;
}
/**
 * CreateHashDepositNoCert返回参数结构体
 */
export interface CreateHashDepositNoCertResponse {
    /**
     * 透传字段
  注意：此字段可能返回 null，表示取不到有效值。
     */
    BusinessId: string;
    /**
     * 存证编码
     */
    EvidenceId: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * VerifyEvidenceBlockChainTxHash返回参数结构体
 */
export interface VerifyEvidenceBlockChainTxHashResponse {
    /**
     * 核验结果，true为核验成功，fals为核验失败
     */
    Result: boolean;
    /**
     * 存证时间，仅当核验结果为true时返回
  注意：此字段可能返回 null，表示取不到有效值。
     */
    EvidenceTime: string;
    /**
     * 存证编码，仅当核验结果为true时返回
  注意：此字段可能返回 null，表示取不到有效值。
     */
    EvidenceId: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateAudioDeposit返回参数结构体
 */
export interface CreateAudioDepositResponse {
    /**
     * 业务ID 透传 长度最大不超过64
  注意：此字段可能返回 null，表示取不到有效值。
     */
    BusinessId: string;
    /**
     * 请求成功，返回存证编码,用于查询存证后续业务数据
     */
    EvidenceId: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * GetDepositInfo返回参数结构体
 */
export interface GetDepositInfoResponse {
    /**
     * 存证编号
     */
    EvidenceId: string;
    /**
     * 上链时间
     */
    EvidenceTime: string;
    /**
     * 区块链交易哈希
     */
    EvidenceTxHash: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateHashDepositNoCert请求参数结构体
 */
export interface CreateHashDepositNoCertRequest {
    /**
     * 数据hash
     */
    EvidenceHash: string;
    /**
     * 该字段为透传字段，方便调用方做业务处理， 长度最大不超过64
     */
    BusinessId?: string;
    /**
     * 业务扩展信息
     */
    EvidenceInfo?: string;
}
/**
 * CreateHashDepositNoSeal返回参数结构体
 */
export interface CreateHashDepositNoSealResponse {
    /**
     * 透传字段
  注意：此字段可能返回 null，表示取不到有效值。
     */
    BusinessId: string;
    /**
     * 存证编码
     */
    EvidenceId: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateDocDeposit返回参数结构体
 */
export interface CreateDocDepositResponse {
    /**
     * 业务ID 透传 长度最大不超过64
  注意：此字段可能返回 null，表示取不到有效值。
     */
    BusinessId: string;
    /**
     * 请求成功，返回存证编码,用于查询存证后续业务数据
     */
    EvidenceId: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * GetDepositInfo请求参数结构体
 */
export interface GetDepositInfoRequest {
    /**
     * 存证编码
     */
    EvidenceId: string;
}
/**
 * CreateVideoDeposit返回参数结构体
 */
export interface CreateVideoDepositResponse {
    /**
     * 业务ID 透传 长度最大不超过64
  注意：此字段可能返回 null，表示取不到有效值。
     */
    BusinessId?: string;
    /**
     * 请求成功，返回存证编码,用于查询存证后续业务数据
     */
    EvidenceId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateDataDeposit请求参数结构体
 */
export interface CreateDataDepositRequest {
    /**
     * 业务数据明文(json格式字符串)，最大256kb
     */
    EvidenceInfo: string;
    /**
     * 存证名称(长度最大30)
     */
    EvidenceName: string;
    /**
     * 业务ID 透传 长度最大不超过64
     */
    BusinessId?: string;
    /**
     * 算法类型 0 SM3, 1 SHA256, 2 SHA384 默认0
     */
    HashType?: number;
    /**
     * 存证描述
     */
    EvidenceDescription?: string;
}
/**
 * GetDepositCert返回参数结构体
 */
export interface GetDepositCertResponse {
    /**
     * 存证编码
     */
    EvidenceId?: string;
    /**
     * 存证证书文件临时链接
     */
    EvidenceCert?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateImageDeposit返回参数结构体
 */
export interface CreateImageDepositResponse {
    /**
     * 业务ID 透传 长度最大不超过64
  注意：此字段可能返回 null，表示取不到有效值。
     */
    BusinessId: string;
    /**
     * 请求成功，返回存证编码,用于查询存证后续业务数据
     */
    EvidenceId: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateHashDeposit返回参数结构体
 */
export interface CreateHashDepositResponse {
    /**
     * 透传字段
  注意：此字段可能返回 null，表示取不到有效值。
     */
    BusinessId: string;
    /**
     * 存证编码
     */
    EvidenceId: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}