tencentcloud-sdk-python 3.0.1210__py2.py3-none-any.whl → 3.0.1225__py2.py3-none-any.whl

tencentcloud/es/v20180416/models.py

@@ -1120,6 +1120,8 @@ class CreateInstanceRequest(AbstractModel):
         :type DisasterRecoverGroupAffinity: int
         :param _SubProductCode: 子产品ID枚举值： 开源版："sp_es_io2"， 基础版："sp_es_basic"，白金版："sp_es_platinum"，企业版："sp_es_enterprise"，CDC白金版："sp_es_cdc_platinum"，日志增强版："sp_es_enlogging"，tsearch："sp_tsearch_io2"，logstash："sp_es_logstash" ，可以为空，为空的时候后台取LicenseType映射该字段
         :type SubProductCode: str
+        :param _ReadWriteMode: 读写分离模式：0-不开启，1-本地读写分离，2-远端读写分离
+        :type ReadWriteMode: int
         """
         self._Zone = None
         self._EsVersion = None
@@ -1158,6 +1160,7 @@ class CreateInstanceRequest(AbstractModel):
         self._CdcId = None
         self._DisasterRecoverGroupAffinity = None
         self._SubProductCode = None
+        self._ReadWriteMode = None
 
     @property
     def Zone(self):
@@ -1455,6 +1458,14 @@ class CreateInstanceRequest(AbstractModel):
     def SubProductCode(self, SubProductCode):
         self._SubProductCode = SubProductCode
 
+    @property
+    def ReadWriteMode(self):
+        return self._ReadWriteMode
+
+    @ReadWriteMode.setter
+    def ReadWriteMode(self, ReadWriteMode):
+        self._ReadWriteMode = ReadWriteMode
+
 
     def _deserialize(self, params):
         self._Zone = params.get("Zone")
@@ -1513,6 +1524,7 @@ class CreateInstanceRequest(AbstractModel):
         self._CdcId = params.get("CdcId")
         self._DisasterRecoverGroupAffinity = params.get("DisasterRecoverGroupAffinity")
         self._SubProductCode = params.get("SubProductCode")
+        self._ReadWriteMode = params.get("ReadWriteMode")
         memeber_set = set(params.keys())
         for name, value in vars(self).items():
             property_name = name[1:]
@@ -2093,12 +2105,15 @@ class CreateServerlessSpaceV2Request(AbstractModel):
         :type KibanaWhiteIpList: list of str
         :param _ZoneId: 空间id
         :type ZoneId: int
+        :param _TagList: 标签信息
+        :type TagList: list of TagInfo
         """
         self._VpcInfo = None
         self._SpaceName = None
         self._Zone = None
         self._KibanaWhiteIpList = None
         self._ZoneId = None
+        self._TagList = None
 
     @property
     def VpcInfo(self):
@@ -2140,6 +2155,14 @@ class CreateServerlessSpaceV2Request(AbstractModel):
     def ZoneId(self, ZoneId):
         self._ZoneId = ZoneId
 
+    @property
+    def TagList(self):
+        return self._TagList
+
+    @TagList.setter
+    def TagList(self, TagList):
+        self._TagList = TagList
+
 
     def _deserialize(self, params):
         if params.get("VpcInfo") is not None:
@@ -2152,6 +2175,12 @@ class CreateServerlessSpaceV2Request(AbstractModel):
         self._Zone = params.get("Zone")
         self._KibanaWhiteIpList = params.get("KibanaWhiteIpList")
         self._ZoneId = params.get("ZoneId")
+        if params.get("TagList") is not None:
+            self._TagList = []
+            for item in params.get("TagList"):
+                obj = TagInfo()
+                obj._deserialize(item)
+                self._TagList.append(obj)
         memeber_set = set(params.keys())
         for name, value in vars(self).items():
             property_name = name[1:]
@@ -4706,12 +4735,15 @@ class DescribeServerlessMetricsRequest(AbstractModel):
         :type SpaceId: str
         :param _IndexId: index索引id
         :type IndexId: str
-        :param _MetricType: 指标类型，暂时只支持Storage
+        :param _MetricType: 指标类型，暂时只支持Storage(存储大小),AllMetric(所有存储指标：索引流量、存储大小、文档数量、读请求和写请求)
         :type MetricType: list of str
+        :param _DurationType: 时间长度类型DurationType(1: 3小时, 2: 昨天1天,3: 今日0点到现在)
+        :type DurationType: int
         """
         self._SpaceId = None
         self._IndexId = None
         self._MetricType = None
+        self._DurationType = None
 
     @property
     def SpaceId(self):
@@ -4737,11 +4769,20 @@ class DescribeServerlessMetricsRequest(AbstractModel):
     def MetricType(self, MetricType):
         self._MetricType = MetricType
 
+    @property
+    def DurationType(self):
+        return self._DurationType
+
+    @DurationType.setter
+    def DurationType(self, DurationType):
+        self._DurationType = DurationType
+
 
     def _deserialize(self, params):
         self._SpaceId = params.get("SpaceId")
         self._IndexId = params.get("IndexId")
         self._MetricType = params.get("MetricType")
+        self._DurationType = params.get("DurationType")
         memeber_set = set(params.keys())
         for name, value in vars(self).items():
             property_name = name[1:]
@@ -4761,10 +4802,22 @@ class DescribeServerlessMetricsResponse(AbstractModel):
         r"""
         :param _Storage: storage指标值，单位byte
         :type Storage: float
+        :param _IndexTraffic: IndexTraffic指标值，单位byte
+        :type IndexTraffic: float
+        :param _ReadReqTimes: 读请求数，单位次数
+        :type ReadReqTimes: int
+        :param _WriteReqTimes: 写请求数，单位次数
+        :type WriteReqTimes: int
+        :param _DocCount: 文档数量，单位个数
+        :type DocCount: int
         :param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
         :type RequestId: str
         """
         self._Storage = None
+        self._IndexTraffic = None
+        self._ReadReqTimes = None
+        self._WriteReqTimes = None
+        self._DocCount = None
         self._RequestId = None
 
     @property
@@ -4775,6 +4828,38 @@ class DescribeServerlessMetricsResponse(AbstractModel):
     def Storage(self, Storage):
         self._Storage = Storage
 
+    @property
+    def IndexTraffic(self):
+        return self._IndexTraffic
+
+    @IndexTraffic.setter
+    def IndexTraffic(self, IndexTraffic):
+        self._IndexTraffic = IndexTraffic
+
+    @property
+    def ReadReqTimes(self):
+        return self._ReadReqTimes
+
+    @ReadReqTimes.setter
+    def ReadReqTimes(self, ReadReqTimes):
+        self._ReadReqTimes = ReadReqTimes
+
+    @property
+    def WriteReqTimes(self):
+        return self._WriteReqTimes
+
+    @WriteReqTimes.setter
+    def WriteReqTimes(self, WriteReqTimes):
+        self._WriteReqTimes = WriteReqTimes
+
+    @property
+    def DocCount(self):
+        return self._DocCount
+
+    @DocCount.setter
+    def DocCount(self, DocCount):
+        self._DocCount = DocCount
+
     @property
     def RequestId(self):
         return self._RequestId
@@ -4786,6 +4871,10 @@ class DescribeServerlessMetricsResponse(AbstractModel):
 
     def _deserialize(self, params):
         self._Storage = params.get("Storage")
+        self._IndexTraffic = params.get("IndexTraffic")
+        self._ReadReqTimes = params.get("ReadReqTimes")
+        self._WriteReqTimes = params.get("WriteReqTimes")
+        self._DocCount = params.get("DocCount")
         self._RequestId = params.get("RequestId")
 
 
@@ -4957,6 +5046,8 @@ class DescribeServerlessSpacesRequest(AbstractModel):
         :type Offset: int
         :param _Limit: 分页条数
         :type Limit: int
+        :param _TagList: 标签信息
+        :type TagList: list of TagInfo
         """
         self._SpaceIds = None
         self._SpaceNames = None
@@ -4965,6 +5056,7 @@ class DescribeServerlessSpacesRequest(AbstractModel):
         self._VpcIds = None
         self._Offset = None
         self._Limit = None
+        self._TagList = None
 
     @property
     def SpaceIds(self):
@@ -5022,6 +5114,14 @@ class DescribeServerlessSpacesRequest(AbstractModel):
     def Limit(self, Limit):
         self._Limit = Limit
 
+    @property
+    def TagList(self):
+        return self._TagList
+
+    @TagList.setter
+    def TagList(self, TagList):
+        self._TagList = TagList
+
 
     def _deserialize(self, params):
         self._SpaceIds = params.get("SpaceIds")
@@ -5031,6 +5131,12 @@ class DescribeServerlessSpacesRequest(AbstractModel):
         self._VpcIds = params.get("VpcIds")
         self._Offset = params.get("Offset")
         self._Limit = params.get("Limit")
+        if params.get("TagList") is not None:
+            self._TagList = []
+            for item in params.get("TagList"):
+                obj = TagInfo()
+                obj._deserialize(item)
+                self._TagList.append(obj)
         memeber_set = set(params.keys())
         for name, value in vars(self).items():
             property_name = name[1:]
@@ -7631,6 +7737,100 @@ class InquirePriceRenewInstanceResponse(AbstractModel):
         self._RequestId = params.get("RequestId")
 
 
+class InstallInstanceModelRequest(AbstractModel):
+    """InstallInstanceModel请求参数结构体
+
+    """
+
+    def __init__(self):
+        r"""
+        :param _InstanceId: 实例ID
+        :type InstanceId: str
+        :param _UsrCosModelUrlList: 客户上传到自己cos的地址列表
+        :type UsrCosModelUrlList: list of str
+        """
+        self._InstanceId = None
+        self._UsrCosModelUrlList = None
+
+    @property
+    def InstanceId(self):
+        return self._InstanceId
+
+    @InstanceId.setter
+    def InstanceId(self, InstanceId):
+        self._InstanceId = InstanceId
+
+    @property
+    def UsrCosModelUrlList(self):
+        return self._UsrCosModelUrlList
+
+    @UsrCosModelUrlList.setter
+    def UsrCosModelUrlList(self, UsrCosModelUrlList):
+        self._UsrCosModelUrlList = UsrCosModelUrlList
+
+
+    def _deserialize(self, params):
+        self._InstanceId = params.get("InstanceId")
+        self._UsrCosModelUrlList = params.get("UsrCosModelUrlList")
+        memeber_set = set(params.keys())
+        for name, value in vars(self).items():
+            property_name = name[1:]
+            if property_name in memeber_set:
+                memeber_set.remove(property_name)
+        if len(memeber_set) > 0:
+            warnings.warn("%s fileds are useless." % ",".join(memeber_set))
+        
+
+
+class InstallInstanceModelResponse(AbstractModel):
+    """InstallInstanceModel返回参数结构体
+
+    """
+
+    def __init__(self):
+        r"""
+        :param _FlowId: 发起异步流程的flowId
+        :type FlowId: str
+        :param _ErrMsg: 调用接口的错误信息
+        :type ErrMsg: str
+        :param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+        :type RequestId: str
+        """
+        self._FlowId = None
+        self._ErrMsg = None
+        self._RequestId = None
+
+    @property
+    def FlowId(self):
+        return self._FlowId
+
+    @FlowId.setter
+    def FlowId(self, FlowId):
+        self._FlowId = FlowId
+
+    @property
+    def ErrMsg(self):
+        return self._ErrMsg
+
+    @ErrMsg.setter
+    def ErrMsg(self, ErrMsg):
+        self._ErrMsg = ErrMsg
+
+    @property
+    def RequestId(self):
+        return self._RequestId
+
+    @RequestId.setter
+    def RequestId(self, RequestId):
+        self._RequestId = RequestId
+
+
+    def _deserialize(self, params):
+        self._FlowId = params.get("FlowId")
+        self._ErrMsg = params.get("ErrMsg")
+        self._RequestId = params.get("RequestId")
+
+
 class InstanceInfo(AbstractModel):
     """实例详细信息
 
@@ -7874,6 +8074,12 @@ RENEW_FLAG_DEFAULT：不自动续费
         :param _SubProductCode: 子产品ID枚举值： 开源版："sp_es_io2"， 基础版："sp_es_basic"，白金版："sp_es_platinum"，企业版："sp_es_enterprise"，CDC白金版："sp_es_cdc_platinum"，日志增强版："sp_es_enlogging"，tsearch："sp_tsearch_io2"，logstash："sp_es_logstash" ，可以为空，为空的时候后台取LicenseType映射该字段
 注意：此字段可能返回 null，表示取不到有效值。
         :type SubProductCode: str
+        :param _CosBucketStorageSize: 存算分离cos用量，单位M
+注意：此字段可能返回 null，表示取不到有效值。
+        :type CosBucketStorageSize: int
+        :param _ReadWriteMode: 读写分离模式：0-不开启，1-本地读写分离，2-远端读写分离
+注意：此字段可能返回 null，表示取不到有效值。
+        :type ReadWriteMode: int
         """
         self._InstanceId = None
         self._InstanceName = None
@@ -7964,6 +8170,8 @@ RENEW_FLAG_DEFAULT：不自动续费
         self._NetConnectScheme = None
         self._DisasterRecoverGroupAffinity = None
         self._SubProductCode = None
+        self._CosBucketStorageSize = None
+        self._ReadWriteMode = None
 
     @property
     def InstanceId(self):
@@ -8677,6 +8885,22 @@ RENEW_FLAG_DEFAULT：不自动续费
     def SubProductCode(self, SubProductCode):
         self._SubProductCode = SubProductCode
 
+    @property
+    def CosBucketStorageSize(self):
+        return self._CosBucketStorageSize
+
+    @CosBucketStorageSize.setter
+    def CosBucketStorageSize(self, CosBucketStorageSize):
+        self._CosBucketStorageSize = CosBucketStorageSize
+
+    @property
+    def ReadWriteMode(self):
+        return self._ReadWriteMode
+
+    @ReadWriteMode.setter
+    def ReadWriteMode(self, ReadWriteMode):
+        self._ReadWriteMode = ReadWriteMode
+
 
     def _deserialize(self, params):
         self._InstanceId = params.get("InstanceId")
@@ -8814,6 +9038,8 @@ RENEW_FLAG_DEFAULT：不自动续费
         self._NetConnectScheme = params.get("NetConnectScheme")
         self._DisasterRecoverGroupAffinity = params.get("DisasterRecoverGroupAffinity")
         self._SubProductCode = params.get("SubProductCode")
+        self._CosBucketStorageSize = params.get("CosBucketStorageSize")
+        self._ReadWriteMode = params.get("ReadWriteMode")
         memeber_set = set(params.keys())
         for name, value in vars(self).items():
             property_name = name[1:]
@@ -12057,6 +12283,9 @@ class ServerlessIndexMetaField(AbstractModel):
         :type StorageType: int
         :param _TagList: 标签信息
         :type TagList: list of TagInfo
+        :param _IndexTraffic: 3782478.47
+注意：此字段可能返回 null，表示取不到有效值。
+        :type IndexTraffic: float
         """
         self._AppId = None
         self._IndexName = None
@@ -12075,6 +12304,7 @@ class ServerlessIndexMetaField(AbstractModel):
         self._SpaceName = None
         self._StorageType = None
         self._TagList = None
+        self._IndexTraffic = None
 
     @property
     def AppId(self):
@@ -12212,6 +12442,14 @@ class ServerlessIndexMetaField(AbstractModel):
     def TagList(self, TagList):
         self._TagList = TagList
 
+    @property
+    def IndexTraffic(self):
+        return self._IndexTraffic
+
+    @IndexTraffic.setter
+    def IndexTraffic(self, IndexTraffic):
+        self._IndexTraffic = IndexTraffic
+
 
     def _deserialize(self, params):
         self._AppId = params.get("AppId")
@@ -12242,6 +12480,7 @@ class ServerlessIndexMetaField(AbstractModel):
                 obj = TagInfo()
                 obj._deserialize(item)
                 self._TagList.append(obj)
+        self._IndexTraffic = params.get("IndexTraffic")
         memeber_set = set(params.keys())
         for name, value in vars(self).items():
             property_name = name[1:]
@@ -12517,6 +12756,9 @@ class ServerlessSpace(AbstractModel):
         :param _ClusterType: 0
 注意：此字段可能返回 null，表示取不到有效值。
         :type ClusterType: int
+        :param _TagList: key:value
+注意：此字段可能返回 null，表示取不到有效值。
+        :type TagList: list of TagInfo
         """
         self._SpaceId = None
         self._SpaceName = None
@@ -12537,6 +12779,7 @@ class ServerlessSpace(AbstractModel):
         self._AppId = None
         self._KibanaLanguage = None
         self._ClusterType = None
+        self._TagList = None
 
     @property
     def SpaceId(self):
@@ -12690,6 +12933,14 @@ class ServerlessSpace(AbstractModel):
     def ClusterType(self, ClusterType):
         self._ClusterType = ClusterType
 
+    @property
+    def TagList(self):
+        return self._TagList
+
+    @TagList.setter
+    def TagList(self, TagList):
+        self._TagList = TagList
+
 
     def _deserialize(self, params):
         self._SpaceId = params.get("SpaceId")
@@ -12720,6 +12971,12 @@ class ServerlessSpace(AbstractModel):
         self._AppId = params.get("AppId")
         self._KibanaLanguage = params.get("KibanaLanguage")
         self._ClusterType = params.get("ClusterType")
+        if params.get("TagList") is not None:
+            self._TagList = []
+            for item in params.get("TagList"):
+                obj = TagInfo()
+                obj._deserialize(item)
+                self._TagList.append(obj)
         memeber_set = set(params.keys())
         for name, value in vars(self).items():
             property_name = name[1:]
@@ -13740,6 +13997,8 @@ CLOSE 关闭
         :type ShardAllocationConcurrents: int
         :param _ShardAllocationBytes: 分片迁移并发速度
         :type ShardAllocationBytes: int
+        :param _ReadWriteMode: 读写分离模式：-1-不开启，1-本地读写分离，2-远端读写分离
+        :type ReadWriteMode: int
         """
         self._InstanceId = None
         self._InstanceName = None
@@ -13781,6 +14040,7 @@ CLOSE 关闭
         self._CvmDelayOnlineTime = None
         self._ShardAllocationConcurrents = None
         self._ShardAllocationBytes = None
+        self._ReadWriteMode = None
 
     @property
     def InstanceId(self):
@@ -14102,6 +14362,14 @@ CLOSE 关闭
     def ShardAllocationBytes(self, ShardAllocationBytes):
         self._ShardAllocationBytes = ShardAllocationBytes
 
+    @property
+    def ReadWriteMode(self):
+        return self._ReadWriteMode
+
+    @ReadWriteMode.setter
+    def ReadWriteMode(self, ReadWriteMode):
+        self._ReadWriteMode = ReadWriteMode
+
 
     def _deserialize(self, params):
         self._InstanceId = params.get("InstanceId")
@@ -14171,6 +14439,7 @@ CLOSE 关闭
         self._CvmDelayOnlineTime = params.get("CvmDelayOnlineTime")
         self._ShardAllocationConcurrents = params.get("ShardAllocationConcurrents")
         self._ShardAllocationBytes = params.get("ShardAllocationBytes")
+        self._ReadWriteMode = params.get("ReadWriteMode")
         memeber_set = set(params.keys())
         for name, value in vars(self).items():
             property_name = name[1:]

tencentcloud/ess/v20201111/ess_client.py

@@ -178,6 +178,64 @@ class EssClient(AbstractClient):
                 raise TencentCloudSDKException(type(e).__name__, str(e))
 
 
+    def CreateBatchInitOrganizationUrl(self, request):
+        """支持企业进行批量初始化操作：
+
+        此接口存在以下限制：
+        1. 若批量操作中包含<font  color="red">加入集团企业</font>操作,则调用此接口的员工须有<font  color="red">集团企业管理权限</font>。
+        2. 批量操作的企业需要已经完成电子签的认证流程。
+        3. 通过此接口生成的链接在小程序端进行操作时，操作人需要是<font  color="red">所有企业的超管或法人</font>。
+        4. 批量操作的企业，需要是<a href="https://qian.tencent.com/developers/companyApis/organizations/CreateOrganizationAuthUrl" target="_blank">通过平台方引导认证</a>的企业。
+        5. <font  color="red">操作链接过期时间默认为生成链接后7天。</font>
+
+        :param request: Request instance for CreateBatchInitOrganizationUrl.
+        :type request: :class:`tencentcloud.ess.v20201111.models.CreateBatchInitOrganizationUrlRequest`
+        :rtype: :class:`tencentcloud.ess.v20201111.models.CreateBatchInitOrganizationUrlResponse`
+
+        """
+        try:
+            params = request._serialize()
+            headers = request.headers
+            body = self.call("CreateBatchInitOrganizationUrl", params, headers=headers)
+            response = json.loads(body)
+            model = models.CreateBatchInitOrganizationUrlResponse()
+            model._deserialize(response["Response"])
+            return model
+        except Exception as e:
+            if isinstance(e, TencentCloudSDKException):
+                raise
+            else:
+                raise TencentCloudSDKException(type(e).__name__, str(e))
+
+
+    def CreateBatchOrganizationAuthorizationUrl(self, request):
+        """此接口用于获取企业批量认证链接-单链接包含多条认证流。
+
+        前提条件：已调用 [CreateBatchOrganizationRegistrationTasks创建企业批量认证链接任务接口](https://qian.tencent.com/developers/companyApis/organizations/CreateBatchOrganizationRegistrationTasks) 和[查询企业批量认证链接DescribeBatchOrganizationRegistrationUrls](https://qian.tencent.com/developers/companyApis/organizations/DescribeBatchOrganizationRegistrationUrls) 确保认证任务已经完成。
+
+        异步任务的处理完成时间视当前已提交的任务量、任务的复杂程度等因素决定，正常情况下 3~5 秒即可完成，但也可能需要更长的时间。
+        此链接包含多条认证流程，使用该链接可以批量的对企业进行认证。
+
+        :param request: Request instance for CreateBatchOrganizationAuthorizationUrl.
+        :type request: :class:`tencentcloud.ess.v20201111.models.CreateBatchOrganizationAuthorizationUrlRequest`
+        :rtype: :class:`tencentcloud.ess.v20201111.models.CreateBatchOrganizationAuthorizationUrlResponse`
+
+        """
+        try:
+            params = request._serialize()
+            headers = request.headers
+            body = self.call("CreateBatchOrganizationAuthorizationUrl", params, headers=headers)
+            response = json.loads(body)
+            model = models.CreateBatchOrganizationAuthorizationUrlResponse()
+            model._deserialize(response["Response"])
+            return model
+        except Exception as e:
+            if isinstance(e, TencentCloudSDKException):
+                raise
+            else:
+                raise TencentCloudSDKException(type(e).__name__, str(e))
+
+
     def CreateBatchOrganizationRegistrationTasks(self, request):
         """本接口（CreateBatchOrganizationRegistrationTasks）用于批量创建企业认证链接
         该接口为异步提交任务接口,需要跟查询企业批量认证链接(DescribeBatchOrganizationRegistrationUrls) 配合使用.
@@ -258,7 +316,7 @@ class EssClient(AbstractClient):
         """通过此接口，可以创建小程序批量签署链接，个人/企业员工可通过此链接跳转至小程序进行批量签署。请确保生成链接时的身份信息与签署合同参与方的信息保持一致。
 
         注意事项：
-        - 使用此接口生成链接，需要贵企业先开通 <font color="red">使用手机号验证签署方身份 </font>功能。您可以在 <b>【腾讯电子签网页端】->【企业设置】->【拓展服务】</b>中找到该功能。
+        - 使用此接口生成链接，需要贵企业先开通 <font color="red">个人签署方仅校验手机号 </font>功能。您可以在 <b>【腾讯电子签网页端】->【企业设置】->【拓展服务】</b>中找到该功能。
         - 生成批量签署链接时，<font color="red">合同目标参与方的状态必须为<b>待签署</b>状态</font>。签署人点击链接后需要输入短信验证码才能查看合同内容。
         - 企业员工批量签署链接：需要传入签署方所在企业名称，用户名字和手机号（或者身份证件信息）参数来生成签署链接。<font color="red">该签署方企业必须已完成腾讯电子签企业认证</font>
         - 个人批量签署链接：需要传入签署方用户名字和手机号（或者身份证件信息）参数来生成签署链接。个人批量签署进行的合同的签名区， 全部变成<font color="red">手写签名</font>（不管合同里边设置的签名限制）来进行。
@@ -2289,9 +2347,9 @@ class EssClient(AbstractClient):
     def DescribeSignFaceVideo(self, request):
         """该接口用于在使用视频认证方式签署合同后，获取用户的签署人脸认证视频。
 
-        1. 该接口**仅适用于在H5端签署**的合同，**在通过视频认证后**获取人脸图片。
-        2. 该接口**不支持小程序端**的签署人脸图片获取。
-        3. 请在**签署完成后的三天内**获取人脸图片，**过期后将无法获取**。
+        1. 该接口**仅适用于在H5端签署**的合同，**在通过视频认证后**获取人脸视频。
+        2. 该接口**不支持小程序端**的签署人脸视频获取。
+        3. 请在**签署完成后的三天内**获取人脸视频，**过期后将无法获取**。
 
         **注意：该接口需要开通白名单，请联系客户经理开通后使用。**