tencentcloud-sdk-python 3.0.1050__py2.py3-none-any.whl → 3.0.1051__py2.py3-none-any.whl

tencentcloud/essbasic/v20210526/models.py

@@ -1859,9 +1859,6 @@ class ChannelCreateBatchQuickSignUrlRequest(AbstractModel):
 
     def __init__(self):
         r"""
-        :param _FlowIds: 批量签署的合同流程ID数组。
-注: `在调用此接口时，请确保合同流程均为本企业发起，且合同数量不超过100个。`
-        :type FlowIds: list of str
         :param _FlowApproverInfo: 批量签署的流程签署人，其中姓名(ApproverName)、参与人类型(ApproverType)必传，手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。
 注:
 `1. ApproverType目前只支持个人类型的签署人。`
@@ -1870,6 +1867,12 @@ class ChannelCreateBatchQuickSignUrlRequest(AbstractModel):
         :type FlowApproverInfo: :class:`tencentcloud.essbasic.v20210526.models.FlowApproverInfo`
         :param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
         :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
+        :param _FlowIds: 批量签署的合同流程ID数组。
+注: `在调用此接口时，请确保合同流程均为本企业发起，且合同数量不超过100个。`
+        :type FlowIds: list of str
+        :param _FlowGroupId: 合同组编号
+注：`该参数和合同流程ID数组必须二选一`
+        :type FlowGroupId: str
         :param _JumpUrl: 签署完之后的H5页面的跳转链接，此链接及支持http://和https://，最大长度1000个字符。(建议https协议)
         :type JumpUrl: str
         :param _SignatureTypes: 指定批量签署合同的签名类型，可传递以下值：
@@ -1888,21 +1891,14 @@ class ChannelCreateBatchQuickSignUrlRequest(AbstractModel):
 <li>您可以传递多种值，表示可用多种认证校验方式。</li></ul>
         :type ApproverSignTypes: list of int
         """
-        self._FlowIds = None
         self._FlowApproverInfo = None
         self._Agent = None
+        self._FlowIds = None
+        self._FlowGroupId = None
         self._JumpUrl = None
         self._SignatureTypes = None
         self._ApproverSignTypes = None
 
-    @property
-    def FlowIds(self):
-        return self._FlowIds
-
-    @FlowIds.setter
-    def FlowIds(self, FlowIds):
-        self._FlowIds = FlowIds
-
     @property
     def FlowApproverInfo(self):
         return self._FlowApproverInfo
@@ -1919,6 +1915,22 @@ class ChannelCreateBatchQuickSignUrlRequest(AbstractModel):
     def Agent(self, Agent):
         self._Agent = Agent
 
+    @property
+    def FlowIds(self):
+        return self._FlowIds
+
+    @FlowIds.setter
+    def FlowIds(self, FlowIds):
+        self._FlowIds = FlowIds
+
+    @property
+    def FlowGroupId(self):
+        return self._FlowGroupId
+
+    @FlowGroupId.setter
+    def FlowGroupId(self, FlowGroupId):
+        self._FlowGroupId = FlowGroupId
+
     @property
     def JumpUrl(self):
         return self._JumpUrl
@@ -1945,13 +1957,14 @@ class ChannelCreateBatchQuickSignUrlRequest(AbstractModel):
 
 
     def _deserialize(self, params):
-        self._FlowIds = params.get("FlowIds")
         if params.get("FlowApproverInfo") is not None:
             self._FlowApproverInfo = FlowApproverInfo()
             self._FlowApproverInfo._deserialize(params.get("FlowApproverInfo"))
         if params.get("Agent") is not None:
             self._Agent = Agent()
             self._Agent._deserialize(params.get("Agent"))
+        self._FlowIds = params.get("FlowIds")
+        self._FlowGroupId = params.get("FlowGroupId")
         self._JumpUrl = params.get("JumpUrl")
         self._SignatureTypes = params.get("SignatureTypes")
         self._ApproverSignTypes = params.get("ApproverSignTypes")
@@ -2057,6 +2070,7 @@ class ChannelCreateBatchSignUrlRequest(AbstractModel):
 <li>请确认该名称与企业营业执照中注册的名称一致。</li>
 <li>如果名称中包含英文括号()，请使用中文括号（）代替。</li>
 <li>请确保此企业已完成腾讯电子签企业认证。</li>
+<li>若为子客企业，请确保员工已经加入企业。</li>
 </ul>
         :type OrganizationName: str
         :param _JumpToDetail: 是否直接跳转至合同内容页面进行签署
@@ -4677,6 +4691,8 @@ class ChannelCreatePreparedPersonalEsignRequest(AbstractModel):
         :type EnableAutoSign: bool
         :param _LicenseType: 设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后，将扣减购买的个人自动签账号许可一次（1年有效期），不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可，开通后将扣减购买的个人自动签账号许可一次 1-不绑定，发起合同时将按标准合同套餐进行扣减	
         :type LicenseType: int
+        :param _SceneKey: <ul><li> **E_PRESCRIPTION_AUTO_SIGN** :  电子处方场景</li><li> **OTHER** :  通用场景</li></ul>
+        :type SceneKey: str
         """
         self._Agent = None
         self._UserName = None
@@ -4689,6 +4705,7 @@ class ChannelCreatePreparedPersonalEsignRequest(AbstractModel):
         self._Mobile = None
         self._EnableAutoSign = None
         self._LicenseType = None
+        self._SceneKey = None
 
     @property
     def Agent(self):
@@ -4778,6 +4795,14 @@ class ChannelCreatePreparedPersonalEsignRequest(AbstractModel):
     def LicenseType(self, LicenseType):
         self._LicenseType = LicenseType
 
+    @property
+    def SceneKey(self):
+        return self._SceneKey
+
+    @SceneKey.setter
+    def SceneKey(self, SceneKey):
+        self._SceneKey = SceneKey
+
 
     def _deserialize(self, params):
         if params.get("Agent") is not None:
@@ -4795,6 +4820,7 @@ class ChannelCreatePreparedPersonalEsignRequest(AbstractModel):
         self._Mobile = params.get("Mobile")
         self._EnableAutoSign = params.get("EnableAutoSign")
         self._LicenseType = params.get("LicenseType")
+        self._SceneKey = params.get("SceneKey")
         memeber_set = set(params.keys())
         for name, value in vars(self).items():
             property_name = name[1:]
@@ -7682,32 +7708,24 @@ class ChannelOrganizationInfo(AbstractModel):
 
     def __init__(self):
         r"""
-        :param _OrganizationId: 电子签企业Id
-注意：此字段可能返回 null，表示取不到有效值。
+        :param _OrganizationId: 电子签平台给企业分配的ID（在不同应用下同一个企业会分配通用的ID）
         :type OrganizationId: str
-        :param _OrganizationOpenId: 电子签企业OpenId
-注意：此字段可能返回 null，表示取不到有效值。
+        :param _OrganizationOpenId: 第三方平台子客企业的唯一标识
         :type OrganizationOpenId: str
-        :param _OrganizationName: 企业名称
-注意：此字段可能返回 null，表示取不到有效值。
+        :param _OrganizationName: 第三方平台子客企业名称
         :type OrganizationName: str
-        :param _UnifiedSocialCreditCode: 企业信用代码
-注意：此字段可能返回 null，表示取不到有效值。
+        :param _UnifiedSocialCreditCode: 企业的统一社会信用代码
         :type UnifiedSocialCreditCode: str
-        :param _LegalName: 法人姓名
-注意：此字段可能返回 null，表示取不到有效值。
+        :param _LegalName: 企业法定代表人的姓名
         :type LegalName: str
-        :param _LegalOpenId: 法人OpenId
-注意：此字段可能返回 null，表示取不到有效值。
+        :param _LegalOpenId: 企业法定代表人作为第三方平台子客企业员工的唯一标识
         :type LegalOpenId: str
-        :param _AdminName: 超管姓名
-注意：此字段可能返回 null，表示取不到有效值。
+        :param _AdminName: 企业超级管理员的姓名
         :type AdminName: str
-        :param _AdminOpenId: 超管OpenId
-注意：此字段可能返回 null，表示取不到有效值。
+        :param _AdminOpenId: 企业超级管理员作为第三方平台子客企业员工的唯一标识
         :type AdminOpenId: str
-        :param _AdminMobile: 超管手机号，脱敏后返回
-注意：此字段可能返回 null，表示取不到有效值。
+        :param _AdminMobile: 企业超级管理员的手机号码
+**注**：`手机号码脱敏（隐藏部分用*替代）`
         :type AdminMobile: str
         :param _AuthorizationStatus: 企业认证状态字段。值如下：
 <ul>
@@ -7718,7 +7736,6 @@ class ChannelOrganizationInfo(AbstractModel):
   <li>**"VERIFYING"**： 认证中的企业</li>
   <li>**"VERIFIED"**： 已认证的企业</li>
 </ul>
-注意：此字段可能返回 null，表示取不到有效值。
         :type AuthorizationStatus: str
         :param _AuthorizationType: 企业认证方式字段。值如下：
 <ul>
@@ -7727,7 +7744,6 @@ class ChannelOrganizationInfo(AbstractModel):
   <li>**"AuthorizationLegalPerson"**： 法人授权超管</li>
   <li>**"AuthorizationLegalIdentity"**： 法人直接认证</li>
 </ul>
-注意：此字段可能返回 null，表示取不到有效值。
         :type AuthorizationType: str
         """
         self._OrganizationId = None
@@ -10900,21 +10916,22 @@ class DescribeChannelOrganizationsRequest(AbstractModel):
 渠道应用标识: Agent.AppId
 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
+
 第三方平台子客企业和员工必须已经经过实名认证
         :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
         :param _Limit: 指定分页每页返回的数据条数，单页最大支持 200。
         :type Limit: int
-        :param _OrganizationOpenId: 子客OrganizationOpenId，定向查询某个子客的企业数据。
+        :param _OrganizationOpenId: 该字段是指第三方平台子客企业的唯一标识，用于查询单独某个子客的企业数据。
+
+**注**：`如果需要批量查询本应用下的所有企业的信息，则该字段不需要赋值`
         :type OrganizationOpenId: str
-        :param _AuthorizationStatusList: 企业认证状态过滤字段。可值如下：
-<ul>
-  <li>**"UNVERIFIED"**： 未认证的企业</li>
+        :param _AuthorizationStatusList: 可以按照当前企业的认证状态进行过滤。可值如下：
+<ul><li>**"UNVERIFIED"**： 未认证的企业</li>
   <li>**"VERIFYINGLEGALPENDINGAUTHORIZATION"**： 认证中待法人授权的企业</li>
   <li>**"VERIFYINGAUTHORIZATIONFILEPENDING"**： 认证中授权书审核中的企业</li>
   <li>**"VERIFYINGAUTHORIZATIONFILEREJECT"**： 认证中授权书已驳回的企业</li>
-  <li>**"VERIFYING"**： 认证中的企业</li>
-  <li>**"VERIFIED"**： 已认证的企业</li>
-</ul>
+  <li>**"VERIFYING"**： 认证进行中的企业</li>
+  <li>**"VERIFIED"**： 已认证完成的企业</li></ul>
         :type AuthorizationStatusList: list of str
         :param _Offset: 指定分页返回第几页的数据，如果不传默认返回第一页。 页码从 0 开始，即首页为 0，最大20000。
         :type Offset: int
@@ -10991,13 +11008,13 @@ class DescribeChannelOrganizationsResponse(AbstractModel):
 
     def __init__(self):
         r"""
-        :param _ChannelOrganizationInfos: 企业企业信息列表。
+        :param _ChannelOrganizationInfos: 满足查询条件的企业信息列表。
         :type ChannelOrganizationInfos: list of ChannelOrganizationInfo
         :param _Offset: 指定分页返回第几页的数据。页码从 0 开始，即首页为 0，最大20000。
         :type Offset: int
         :param _Limit: 指定分页每页返回的数据条数，单页最大支持 200。
         :type Limit: int
-        :param _Total: 符合条件的企业数量。
+        :param _Total: 满足查询条件的企业总数量。
         :type Total: int
         :param _RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
         :type RequestId: str
@@ -14197,14 +14214,14 @@ class FormField(AbstractModel):
     | cells.N.columnStart | Integer | 单元格坐标：列起始index                           |
     | cells.N.columnEnd   | Integer | 单元格坐标：列结束index                           |
     | cells.N.content     | String  | 单元格内容，字数不超过100                         |
-    | cells.N.style         | String  | 单元格字体风格配置 ，风格配置的json字符串  如： {"font":"黑体","fontSize":12,"color":"FFFFFF","bold":true,"align":"CENTER"}      |
+    | cells.N.style         | String  | 单元格字体风格配置 ，风格配置的json字符串  如： {"font":"黑体","fontSize":12,"color":"#FFFFFF","bold":true,"align":"CENTER"}      |
 
     表格参数headers说明
     widthPercent Integer 表头单元格列占总表头的比例，例如1：30表示 此列占表头的30%，不填写时列宽度平均拆分；例如2：总2列，某一列填写40，剩余列可以为空，按照60计算。；例如3：总3列，某一列填写30，剩余2列可以为空，分别为(100-30)/2=35
 
     content String 表头单元格内容，字数不超过100
 
-    style String 为字体风格设置 风格支持： font : 目前支持 黑体、宋体; fontSize： 6-72; color：000000-FFFFFF  字符串形如：  "FFFFFF"; bold ： 是否加粗， true ： 加粗 false： 不加粗; align: 对其方式， 支持 LEFT / RIGHT / CENTER
+    style String 为字体风格设置 风格支持： font : 目前支持 黑体、宋体; fontSize： 6-72; color：000000-FFFFFF  字符串形如：  "#FFFFFF" 或者 "0xFFFFFF"; bold ： 是否加粗， true ： 加粗 false： 不加粗; align: 对其方式， 支持 LEFT / RIGHT / CENTER
 
     """
 

tencentcloud/lcic/v20220817/models.py

@@ -8704,7 +8704,7 @@ class RoomItem(AbstractModel):
         :param _RoomId: 房间ID
 注意：此字段可能返回 null，表示取不到有效值。
         :type RoomId: int
-        :param _Status: 房间状态。0 未开始 ；1进行中  ；2 已结束
+        :param _Status: 房间状态。0 未开始 ；1进行中  ；2 已结束；3已过期
 注意：此字段可能返回 null，表示取不到有效值。
         :type Status: int
         :param _StartTime: 开始时间
@@ -8763,6 +8763,9 @@ class RoomItem(AbstractModel):
         :param _EnableAutoStart: 是否自动开始上课：0 不自动上课（默认） 1 自动上课 live_type=1的时候有效	
 注意：此字段可能返回 null，表示取不到有效值。
         :type EnableAutoStart: int
+        :param _RecordBackground: 录制文件背景图片，支持png、jpg、jpeg、bmp格式，暂不支持透明通道
+注意：此字段可能返回 null，表示取不到有效值。
+        :type RecordBackground: str
         """
         self._Name = None
         self._RoomId = None
@@ -8785,6 +8788,7 @@ class RoomItem(AbstractModel):
         self._LiveType = None
         self._RecordLiveUrl = None
         self._EnableAutoStart = None
+        self._RecordBackground = None
 
     @property
     def Name(self):
@@ -8954,6 +8958,14 @@ class RoomItem(AbstractModel):
     def EnableAutoStart(self, EnableAutoStart):
         self._EnableAutoStart = EnableAutoStart
 
+    @property
+    def RecordBackground(self):
+        return self._RecordBackground
+
+    @RecordBackground.setter
+    def RecordBackground(self, RecordBackground):
+        self._RecordBackground = RecordBackground
+
 
     def _deserialize(self, params):
         self._Name = params.get("Name")
@@ -8977,6 +8989,7 @@ class RoomItem(AbstractModel):
         self._LiveType = params.get("LiveType")
         self._RecordLiveUrl = params.get("RecordLiveUrl")
         self._EnableAutoStart = params.get("EnableAutoStart")
+        self._RecordBackground = params.get("RecordBackground")
         memeber_set = set(params.keys())
         for name, value in vars(self).items():
             property_name = name[1:]

tencentcloud/monitor/v20180724/models.py

@@ -3747,16 +3747,16 @@ class CreateExporterIntegrationRequest(AbstractModel):
         r"""
         :param _InstanceId: 实例 ID
         :type InstanceId: str
-        :param _Kind: 类型
+        :param _Kind: 类型(可通过 DescribePrometheusIntegrations 接口获取，取每一项中的 ExporterType 字段)
         :type Kind: str
         :param _Content: 集成配置
         :type Content: str
-        :param _KubeType: Kubernetes 集群类型，取值如下：
+        :param _KubeType: Kubernetes 集群类型，可不填，取值如下：
 <li> 1= 容器集群(TKE) </li>
-<li> 2=弹性集群<EKS> </li>
-<li> 3= Prometheus管理的弹性集群<MEKS> </li>
+<li> 2=弹性集群(EKS) </li>
+<li> 3= Prometheus管理的弹性集群(MEKS) </li>
         :type KubeType: int
-        :param _ClusterId: 集群 ID
+        :param _ClusterId: 集群 ID，可不填
         :type ClusterId: str
         """
         self._InstanceId = None
@@ -5086,13 +5086,13 @@ class CreatePrometheusMultiTenantInstancePostPayModeRequest(AbstractModel):
         r"""
         :param _InstanceName: 实例名
         :type InstanceName: str
-        :param _VpcId: VPC ID
+        :param _VpcId: VPC ID(可通过 vpc:DescribeVpcs 接口获取，与实例同地域)
         :type VpcId: str
-        :param _SubnetId: 子网 ID
+        :param _SubnetId: 子网 ID(可通过 vpc:DescribeSubnets 接口获取)
         :type SubnetId: str
         :param _DataRetentionTime: 数据存储时间（单位天），限制值为15，30，45之一
         :type DataRetentionTime: int
-        :param _Zone: 可用区
+        :param _Zone: 可用区(与子网同可用区)
         :type Zone: str
         :param _TagSpecification: 实例的标签
         :type TagSpecification: list of PrometheusTag
@@ -5313,11 +5313,11 @@ class CreatePrometheusScrapeJobRequest(AbstractModel):
 
     def __init__(self):
         r"""
-        :param _InstanceId: Prometheus 实例 ID，例如：prom-abcd1234
+        :param _InstanceId: Prometheus 实例 ID
         :type InstanceId: str
-        :param _AgentId: Agent ID，例如：agent-abcd1234，可在控制台 Agent 管理中获取
+        :param _AgentId: Agent ID(可通过DescribePrometheusAgents 接口获取)
         :type AgentId: str
-        :param _Config: 抓取任务配置，格式：job_name:xx
+        :param _Config: 抓取任务配置
         :type Config: str
         """
         self._InstanceId = None
@@ -5481,7 +5481,7 @@ class CreateRecordingRuleRequest(AbstractModel):
         r"""
         :param _Name: 聚合规则名称
         :type Name: str
-        :param _Group: 聚合规则组内容，格式为 yaml
+        :param _Group: 聚合规则组内容，格式为 yaml，通过 base64 进行编码。
         :type Group: str
         :param _InstanceId: Prometheus 实例 ID
         :type InstanceId: str
@@ -6116,16 +6116,16 @@ class DeleteExporterIntegrationRequest(AbstractModel):
         r"""
         :param _InstanceId: 实例 ID
         :type InstanceId: str
-        :param _Kind: 类型
+        :param _Kind: 类型(可通过 DescribeExporterIntegrations获取)
         :type Kind: str
         :param _Name: 名字
         :type Name: str
         :param _KubeType: Kubernetes 集群类型，取值如下：
 <li> 1= 容器集群(TKE) </li>
-<li> 2=弹性集群<EKS> </li>
-<li> 3= Prometheus管理的弹性集群<MEKS> </li>
+<li> 2=弹性集群(EKS) </li>
+<li> 3= Prometheus管理的弹性集群(MEKS) </li>
         :type KubeType: int
-        :param _ClusterId: 集群 ID
+        :param _ClusterId: 集群 ID，可不填
         :type ClusterId: str
         """
         self._InstanceId = None
@@ -6838,9 +6838,9 @@ class DeletePrometheusScrapeJobsRequest(AbstractModel):
         r"""
         :param _InstanceId: 实例 ID
         :type InstanceId: str
-        :param _AgentId: Agent ID
+        :param _AgentId: Agent ID(可通过 DescribePrometheusAgents 接口获取)
         :type AgentId: str
-        :param _JobIds: 任务 ID 列表
+        :param _JobIds: 任务 ID 列表(可通过 DescribePrometheusScrapeJobs 接口获取)
         :type JobIds: list of str
         """
         self._InstanceId = None
@@ -30338,6 +30338,13 @@ class UpgradeGrafanaDashboardRequest(AbstractModel):
         :param _InstanceId: 实例 ID
         :type InstanceId: str
         :param _IntegrationCodes: Prometheus 集成项 Code，升级对应的 Dashboard，取值如下：
+<li>qcloud</li>
+<li>cvm_process_exporter</li>
+<li>cvm_node_exporter</li>
+<li>cvm</li>
+<li>kubernetes</li>
+<li>cdwch</li>
+<li>rocketmq</li>
 <li>spring_mvc</li>
 <li>mysql</li>
 <li>go</li>
@@ -30355,6 +30362,8 @@ class UpgradeGrafanaDashboardRequest(AbstractModel):
 <li>tps</li>
 <li>istio</li>
 <li>etcd</li>
+<li>pts</li>
+<li>kong</li>
         :type IntegrationCodes: list of str
         """
         self._InstanceId = None

tencentcloud/monitor/v20180724/monitor_client.py

@@ -213,7 +213,7 @@ class MonitorClient(AbstractClient):
 
 
     def CreateExporterIntegration(self, request):
-        """创建 exporter 集成
+        """创建集成中心 exporter 集成，因集成较多，建议控制台创建集成。(前提：已授权创建托管 EKS 集群，验证方式：1. 控制台界面确认，未提示授权则表示已授权创建；2. 通过 DescribePrometheusInstanceInitStatus 接口查询集群状态，如果托管集群不存在，可通过 RunPrometheusInstance 接口创建)
 
         :param request: Request instance for CreateExporterIntegration.
         :type request: :class:`tencentcloud.monitor.v20180724.models.CreateExporterIntegrationRequest`
@@ -489,7 +489,7 @@ class MonitorClient(AbstractClient):
 
 
     def CreatePrometheusScrapeJob(self, request):
-        """创建 Prometheus 抓取任务
+        """创建 Prometheus Agent 抓取任务
 
         :param request: Request instance for CreatePrometheusScrapeJob.
         :type request: :class:`tencentcloud.monitor.v20180724.models.CreatePrometheusScrapeJobRequest`
@@ -675,7 +675,7 @@ class MonitorClient(AbstractClient):
 
 
     def DeleteExporterIntegration(self, request):
-        """删除 exporter 集成
+        """删除集成中心 exporter 集成
 
         :param request: Request instance for DeleteExporterIntegration.
         :type request: :class:`tencentcloud.monitor.v20180724.models.DeleteExporterIntegrationRequest`
@@ -882,7 +882,7 @@ class MonitorClient(AbstractClient):
 
 
     def DeletePrometheusScrapeJobs(self, request):
-        """删除 Prometheus 抓取任务
+        """删除 Prometheus Agent 抓取任务
 
         :param request: Request instance for DeletePrometheusScrapeJobs.
         :type request: :class:`tencentcloud.monitor.v20180724.models.DeletePrometheusScrapeJobsRequest`
@@ -2341,7 +2341,7 @@ class MonitorClient(AbstractClient):
 
 
     def DestroyPrometheusInstance(self, request):
-        """彻底删除 Prometheus 实例相关数据，给定的实例必须先被 Terminate
+        """彻底删除 Prometheus 实例相关数据，给定的实例必须先被 Terminate(该接口是异步接口，实例是否释放需要通过 DescribePrometheusInstances 接口返回的状态来判断)。
 
         :param request: Request instance for DestroyPrometheusInstance.
         :type request: :class:`tencentcloud.monitor.v20180724.models.DestroyPrometheusInstanceRequest`

tencentcloud/privatedns/v20201028/models.py

@@ -3559,7 +3559,7 @@ class QueryAsyncBindVpcStatusResponse(AbstractModel):
     def __init__(self):
         r"""
         :param _Status: processing 处理中，success 执行成功，
-fail 执行失败
+failed 执行失败
         :type Status: str
         :param _ErrorMsg: 错误信息
 注意：此字段可能返回 null，表示取不到有效值。

tencentcloud/pts/v20210728/models.py

@@ -95,7 +95,7 @@ class AbortJobRequest(AbstractModel):
 
     def __init__(self):
         r"""
-        :param _JobId: 任务ID
+        :param _JobId: 待停止的压测任务的 ID（所有的压测任务 ID 可以从 DescribeJobs 接口获取）
         :type JobId: str
         :param _ProjectId: 项目ID
         :type ProjectId: str
@@ -191,7 +191,7 @@ class AdjustJobSpeedRequest(AbstractModel):
         r"""
         :param _JobId: 任务ID
         :type JobId: str
-        :param _TargetRequestsPerSecond: 目标RPS
+        :param _TargetRequestsPerSecond: 目标 RPS。其取值应大于起始 RPS，并且小于最大 RPS
         :type TargetRequestsPerSecond: int
         """
         self._JobId = None
@@ -1093,11 +1093,11 @@ class CreateAlertChannelRequest(AbstractModel):
 
     def __init__(self):
         r"""
-        :param _NoticeId: Notice ID
+        :param _NoticeId: monitor 服务的告警通知模板的 NoticeId，可从 monitor 服务的云 API 的 DescribeAlarmNotices 接口响应里的 Id 字段获取。（CreateAlertChannel 接口的入参里用于标识一个告警通知模板的 AMPConsumerId 与 NoticeId 二选一即可）
         :type NoticeId: str
         :param _ProjectId: 项目 ID
         :type ProjectId: str
-        :param _AMPConsumerId: AMP Consumer ID
+        :param _AMPConsumerId: monitor 服务的告警通知模板的 AMPConsumerId，可从 monitor 服务的云 API 的 DescribeAlarmNotices 接口响应里的 AMPConsumerId 字段获取。（CreateAlertChannel 接口的入参里用于标识一个告警通知模板的 AMPConsumerId 与 NoticeId 二选一即可）
         :type AMPConsumerId: str
         """
         self._NoticeId = None
@@ -1353,7 +1353,7 @@ class CreateFileRequest(AbstractModel):
 
     def __init__(self):
         r"""
-        :param _FileId: 文件 ID
+        :param _FileId: 文件 ID。其值应为前序步骤上传该文件到 cos 桶后，文件在 cos 桶中的相应目录
         :type FileId: str
         :param _ProjectId: 项目 ID
         :type ProjectId: str
@@ -2489,7 +2489,7 @@ class DeleteAlertChannelRequest(AbstractModel):
         r"""
         :param _ProjectId: 项目 ID
         :type ProjectId: str
-        :param _NoticeId: Notice ID
+        :param _NoticeId: 待删除的通知渠道的 Notice ID（所有通知渠道的 Notice ID 可以从 DescribeAlertChannels 接口获取）
         :type NoticeId: str
         """
         self._ProjectId = None
@@ -2629,7 +2629,7 @@ class DeleteFilesRequest(AbstractModel):
         r"""
         :param _ProjectId: 项目 ID
         :type ProjectId: str
-        :param _FileIds: 文件 ID 数组
+        :param _FileIds: 待删除的文件的 ID（所有文件 ID 可从接口 DescribeFiles 获取）
         :type FileIds: list of str
         """
         self._ProjectId = None
@@ -2697,7 +2697,7 @@ class DeleteJobsRequest(AbstractModel):
 
     def __init__(self):
         r"""
-        :param _JobIds: 任务ID数组
+        :param _JobIds: 待删除的任务的 ID（所有任务的 ID 可以从 DescribeJobs 获取）
         :type JobIds: list of str
         :param _ProjectId: 项目ID
         :type ProjectId: str
@@ -4064,9 +4064,9 @@ class DescribeLabelValuesRequest(AbstractModel):
         :type JobId: str
         :param _ScenarioId: 场景ID
         :type ScenarioId: str
-        :param _Metric: 指标名称
+        :param _Metric: 指标名。取值范围参见 DescribeMetricLabelWithValues 接口返回的所有指标名
         :type Metric: str
-        :param _LabelName: 查询标签名称
+        :param _LabelName: 标签名。取值范围参见 DescribeMetricLabelWithValues 接口返回的指标及其支持的标签名
         :type LabelName: str
         :param _ProjectId: 项目ID
         :type ProjectId: str
@@ -4802,13 +4802,13 @@ class DescribeSampleBatchQueryRequest(AbstractModel):
 
     def __init__(self):
         r"""
-        :param _JobId: job id
+        :param _JobId: 压测任务的 ID
         :type JobId: str
-        :param _ScenarioId: 场景id
+        :param _ScenarioId: 场景的 ID
         :type ScenarioId: str
         :param _Queries: 查询指标数组
         :type Queries: list of InternalMetricQuery
-        :param _ProjectId: 项目ID
+        :param _ProjectId: 项目的 ID
         :type ProjectId: str
         """
         self._JobId = None
@@ -5325,11 +5325,11 @@ class DescribeSampleMatrixQueryRequest(AbstractModel):
         :type ProjectId: str
         :param _ScenarioId: 场景ID
         :type ScenarioId: str
-        :param _Metric: 指标名字
+        :param _Metric: 指标名。取值范围参见 DescribeMetricLabelWithValues 接口返回的所有指标名
         :type Metric: str
-        :param _Aggregation: 聚合函数
+        :param _Aggregation: 聚合函数。取值范围：Rate,Count,Avg,P90,P95,P99,Gauge
         :type Aggregation: str
-        :param _Filters: 指标过滤
+        :param _Filters: 用标签过滤规则来过滤指标，规则中包含标签名 LabelName、标签值 LabelValue、操作符 Operator（0代表相等，1代表不等）
         :type Filters: list of Filter
         :param _GroupBy: 分组
         :type GroupBy: list of str
@@ -5473,13 +5473,13 @@ class DescribeSampleQueryRequest(AbstractModel):
         :type JobId: str
         :param _ScenarioId: 场景Id
         :type ScenarioId: str
-        :param _Metric: 指标名
+        :param _Metric: 指标名。取值范围参见 DescribeMetricLabelWithValues 接口返回的所有指标名
         :type Metric: str
-        :param _Aggregation: 聚合条件
+        :param _Aggregation: 聚合函数。取值范围：Rate,Count,Avg,P90,P95,P99,Gauge
         :type Aggregation: str
         :param _ProjectId: 项目ID
         :type ProjectId: str
-        :param _Labels: 过滤条件
+        :param _Labels: 标签过滤条件。各指标支持的标签参见 DescribeMetricLabelWithValues 接口返回的所有指标及其支持的标签
         :type Labels: list of Label
         """
         self._JobId = None
@@ -6832,11 +6832,11 @@ class InternalMetricQuery(AbstractModel):
         r"""
         :param _Metric: 指标名
         :type Metric: str
-        :param _Aggregation: 聚合函数
+        :param _Aggregation: 聚合函数。取值范围：Rate,Count,Avg,P90,P95,P99,Gauge
         :type Aggregation: str
         :param _Labels: deprecated, 请使用Filters
         :type Labels: list of Label
-        :param _Filters: 指标过滤
+        :param _Filters: 用标签过滤规则来过滤指标，规则中包含标签名 LabelName、标签值 LabelValue、操作符 Operator（0代表相等，1代表不等）
         :type Filters: list of Filter
         :param _GroupBy: 指标分组
         :type GroupBy: list of str
@@ -7544,9 +7544,9 @@ class Label(AbstractModel):
 
     def __init__(self):
         r"""
-        :param _LabelName: label名字
+        :param _LabelName: 标签名
         :type LabelName: str
-        :param _LabelValue: label值
+        :param _LabelValue: 标签值
         :type LabelValue: str
         """
         self._LabelName = None
@@ -10542,7 +10542,7 @@ class UpdateFileScenarioRelationRequest(AbstractModel):
 
     def __init__(self):
         r"""
-        :param _FileId: 文件 ID
+        :param _FileId: 文件 ID。其值应为前序步骤上传该文件到 cos 桶后，文件在 cos 桶中的相应目录
         :type FileId: str
         :param _ProjectId: 项目 ID
         :type ProjectId: str
@@ -10835,7 +10835,7 @@ class UpdateScenarioRequest(AbstractModel):
         :type Name: str
         :param _Description: 场景描述
         :type Description: str
-        :param _Type: 压测引擎类型
+        :param _Type: 压测场景的模式类型。取值范围：pts-http 代表简单模式，pts-js 代表脚本模式，pts-jmeter 代表 JMeter 模式。
         :type Type: str
         :param _Load: 施压配置
         :type Load: :class:`tencentcloud.pts.v20210728.models.Load`