tccli 3.0.1039.1__py2.py3-none-any.whl → 3.0.1040.1__py2.py3-none-any.whl

tccli/services/billing/v20180709/api.json

@@ -175,6 +175,13 @@
       "output": "DescribeDosageDetailByDateResponse",
       "status": "online"
     },
+    "DescribeDosageDetailList": {
+      "document": "获取已接入标准用量明细模板产品的用量明细数据，目前已接入并支持查询的产品包括：云联络中心、实时音视频、实时音视频、智能媒资托管、CODING DevOps、全球IP应用加速",
+      "input": "DescribeDosageDetailListRequest",
+      "name": "获取计量标准接入类产品用量明细",
+      "output": "DescribeDosageDetailListResponse",
+      "status": "online"
+    },
     "DescribeSavingPlanCoverage": {
       "document": "查询当前用户节省计划覆盖率明细数据，如无特别说明，金额单位均为元（国内站）或者美元（国际站）。",
       "input": "DescribeSavingPlanCoverageRequest",
@@ -6169,6 +6176,212 @@
       ],
       "type": "object"
     },
+    "DescribeDosageDetail": {
+      "document": "计量标准接入类产品支持API接口获取用量明细返回数据结构",
+      "members": [
+        {
+          "disabled": false,
+          "document": "日期\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "2023-09-01",
+          "member": "string",
+          "name": "Date",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "账号 ID 是用户在腾讯云的唯一账号标识\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "无",
+          "member": "string",
+          "name": "Uin",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "用量统计类型\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "minute",
+          "member": "string",
+          "name": "DosageType",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "产品编码\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "p_dsa",
+          "member": "string",
+          "name": "ProductCode",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "子产品编码\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "sp_rav_audio_video",
+          "member": "string",
+          "name": "SubProductCode",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "组件类型编码\n\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "v_rav_time",
+          "member": "string",
+          "name": "BillingItemCode",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "组件编码\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "sv_rav_time_subscribe",
+          "member": "string",
+          "name": "SubBillingItemCode",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "产品名称\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "实时音视频",
+          "member": "string",
+          "name": "ProductCodeName",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "子产品名称\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "实时音视频-音视频通话",
+          "member": "string",
+          "name": "SubProductCodeName",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "组件类型\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "时长",
+          "member": "string",
+          "name": "BillingItemCodeName",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "组件\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "订阅时长",
+          "member": "string",
+          "name": "SubBillingItemCodeName",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "用量单位\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "分钟",
+          "member": "string",
+          "name": "DosageUnit",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "用量起始时间\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "2023-02-01 00:00:00",
+          "member": "string",
+          "name": "DosageBeginTime",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "用量截止时间\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "2023-02-01 00:05:00",
+          "member": "string",
+          "name": "DosageEndTime",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "标准用量\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "6",
+          "member": "float",
+          "name": "DosageValue",
+          "output_required": false,
+          "type": "float",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "抵扣用量\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "0",
+          "member": "float",
+          "name": "DeductValue",
+          "output_required": false,
+          "type": "float",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "抵扣余量\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "6",
+          "member": "float",
+          "name": "RemainValue",
+          "output_required": false,
+          "type": "float",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "sdkAppId\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "1400706048",
+          "member": "string",
+          "name": "SdkAppId",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "其他信息\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "[{\"Key\":\"tgr\",\"Value\":\"超高清\"}]",
+          "member": "JsonObject",
+          "name": "AttrStr",
+          "output_required": false,
+          "type": "list",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "用量模板名称\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "[\"实时音视频_时长_5分钟\",                     \"实时音视频_时长_5分钟\"]",
+          "member": "string",
+          "name": "SheetName",
+          "output_required": false,
+          "type": "list",
+          "value_allowed_null": true
+        }
+      ],
+      "usage": "out"
+    },
     "DescribeDosageDetailByDateRequest": {
       "document": "DescribeDosageDetailByDate请求参数结构体",
       "members": [
@@ -6281,6 +6494,88 @@
       ],
       "type": "object"
     },
+    "DescribeDosageDetailListRequest": {
+      "document": "DescribeDosageDetailList请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "用量起始时间，如：2023-02-01",
+          "example": "2023-02-01",
+          "member": "string",
+          "name": "StartTime",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "用量截止时间，如：2023-02-28",
+          "example": "2023-02-28",
+          "member": "string",
+          "name": "EndTime",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "产品编码，已支持查询的产品如下：\np_ccc（云联络中心）\np_rav（实时音视频）\np_pstn（号码保护）\np_smh（智能媒资托管）\np_coding_devops（CODING DevOps）\np_dsa（全球IP应用加速）",
+          "example": "p_ccc",
+          "member": "string",
+          "name": "ProductCode",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "数据偏移量（从0开始）",
+          "example": "0",
+          "member": "uint64",
+          "name": "Offset",
+          "required": true,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "单次数据量（最大3000）",
+          "example": "100",
+          "member": "int64",
+          "name": "Limit",
+          "required": true,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "用量统计类型：用量明细的数据统计汇总周期类型，包括minute-按5分钟汇总、hour-按小时汇总、day-按天汇总、month-按月汇总、comm-其他，默认查询所有类型明细，目前各产品已支持的统计类型如下：\np_ccc（云联络中心）：comm、day\np_rav（实时音视频）：minute、day\np_pstn（号码保护）：comm\np_smh（智能媒资托管）：day\np_coding_devops（CODING DevOps）：comm、day\np_dsa（全球IP应用加速）：minute",
+          "example": "minute",
+          "member": "string",
+          "name": "DosageType",
+          "required": false,
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "DescribeDosageDetailListResponse": {
+      "document": "DescribeDosageDetailList返回参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "用量明细集合",
+          "example": "无",
+          "member": "DescribeDosageDetail",
+          "name": "Record",
+          "output_required": false,
+          "type": "list",
+          "value_allowed_null": false
+        },
+        {
+          "document": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
     "DescribeSavingPlanCoverageRequest": {
       "document": "DescribeSavingPlanCoverage请求参数结构体",
       "members": [
@@ -7280,6 +7575,34 @@
       ],
       "usage": "out"
     },
+    "JsonObject": {
+      "document": "Json对象",
+      "members": [
+        {
+          "disabled": false,
+          "document": "key值",
+          "example": "无",
+          "member": "string",
+          "name": "Key",
+          "output_required": false,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "value值",
+          "example": "无",
+          "member": "string",
+          "name": "Value",
+          "output_required": false,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": false
+        }
+      ],
+      "usage": "both"
+    },
     "PayDealsRequest": {
       "document": "PayDeals请求参数结构体",
       "members": [

tccli/services/billing/v20180709/examples.json

@@ -254,6 +254,14 @@
         "title": "CLB、EIP，视频直播业务按日期获取用量明细"
       }
     ],
+    "DescribeDosageDetailList": [
+      {
+        "document": "获取用量明细数据",
+        "input": "POST / HTTP/1.1\nHost: billing.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeDosageDetailList\n<公共请求参数>\n\n{\n    \"Offset\": 43150,\n    \"Limit\": 3,\n    \"StartTime\": \"2023-09-01\",\n    \"EndTime\": \"2023-09-30\",\n    \"ProductCode\": \"p_dsa\"\n}",
+        "output": "{\n    \"Response\": {\n        \"Record\": [\n            {\n                \"AttrStr\": [\n                    {\n                        \"Key\": \"zoneId\",\n                        \"Value\": \"470004\"\n                    },\n                    {\n                        \"Key\": \"dayPeek\",\n                        \"Value\": \"4872430721\"\n                    },\n                    {\n                        \"Key\": \"regionId\",\n                        \"Value\": \"47\"\n                    }\n                ],\n                \"BillingItemCode\": \"v_dsa_gipa_bandwidth_game\",\n                \"BillingItemCodeName\": \"全球IP应用加速-游戏加速带宽\",\n                \"Date\": \"2023-09-01\",\n                \"DeductValue\": 0,\n                \"DosageBeginTime\": \"2023-09-01 00:02:00\",\n                \"DosageEndTime\": \"2023-09-01 00:02:59\",\n                \"DosageType\": \"minute\",\n                \"DosageUnit\": \"Mbps\",\n                \"DosageValue\": 2206972795,\n                \"ProductCode\": \"p_dsa\",\n                \"ProductCodeName\": \"全站加速网络ECDN\",\n                \"RemainValue\": 2206972795,\n                \"SdkAppId\": \"\",\n                \"SheetName\": [\n                    \"全球IP应用加速_1分钟\"\n                ],\n                \"SubBillingItemCode\": \"sv_dsa_gipa_bandwidth_game_yd_month\",\n                \"SubBillingItemCodeName\": \"GIPA-游戏加速带宽-移动网络-按月结算\",\n                \"SubProductCode\": \"sp_dsa_gipa\",\n                \"SubProductCodeName\": \"全球IP应用加速\",\n                \"Uin\": \"909619400\"\n            }\n        ],\n        \"RequestId\": \"184cd45e-d2e1-4043-a47b-183617836e25\"\n    }\n}",
+        "title": "获取用量明细数据"
+      }
+    ],
     "DescribeSavingPlanCoverage": [
       {
         "document": "查询节省计划覆盖率数据",

tccli/services/cfs/v20190719/api.json

@@ -2097,6 +2097,15 @@
           "name": "Limit",
           "required": false,
           "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "用户自定义名称",
+          "example": "test_fs",
+          "member": "string",
+          "name": "CreationToken",
+          "required": false,
+          "type": "string"
         }
       ],
       "type": "object"

tccli/services/cfw/v20190904/api.json

@@ -5564,6 +5564,16 @@
           "type": "int",
           "value_allowed_null": false
         },
+        {
+          "disabled": false,
+          "document": "规则详情",
+          "example": "无",
+          "member": "IdsWhiteInfo",
+          "name": "Data",
+          "output_required": false,
+          "type": "list",
+          "value_allowed_null": false
+        },
         {
           "disabled": false,
           "document": "返回状态码 0 成功 非0不成功",
@@ -8000,6 +8010,72 @@
       ],
       "usage": "out"
     },
+    "IdsWhiteInfo": {
+      "document": "入侵防御规则白名单详情",
+      "members": [
+        {
+          "disabled": false,
+          "document": "白名单唯一ID\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "50",
+          "member": "int64",
+          "name": "Id",
+          "output_required": false,
+          "type": "int",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "源IP\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "10.23.22.1",
+          "member": "string",
+          "name": "SrcIp",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "目的IP\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "10.23.22.2",
+          "member": "string",
+          "name": "DstIp",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "规则类型\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "srddst",
+          "member": "string",
+          "name": "WhiteRuleType",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "白名单生效防火墙范围： 1 边界防火墙 2 nat防火墙 4 vpc防火墙 7 = 1+2+4 所有防火墙\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "7",
+          "member": "int64",
+          "name": "FwType",
+          "output_required": false,
+          "type": "int",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "入侵防御规则ID\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "20016",
+          "member": "string",
+          "name": "RuleId",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": true
+        }
+      ],
+      "usage": "out"
+    },
     "InstanceInfo": {
       "document": "// InstanceInfo 实例详情结果\ntype InstanceInfo struct {\n\tAppID        string `json:\"AppId\" gorm:\"column:appid\"`\n\tRegion       string `json:\"Region\" gorm:\"column:region\"`\n\tVPCID        string `json:\"VpcId\" gorm:\"column:vpc_id\"`\n\tSubNetID     string `json:\"SubnetId\" gorm:\"column:subnet_id\"`\n\tInstanceID   string `json:\"InstanceId\" gorm:\"column:instance_id\"`\n\tInstanceName string `json:\"InstanceName\" gorm:\"column:instance_name\"`\n\t//InsType common.CVM 3是cvm实例,4是clb实例,5是eni实例,6是mysql,7是redis,8是NAT,9是VPN,10是ES,11是MARIADB,12是KAFKA\n\tInsType   int    `json:\"InsType\" gorm:\"column:instance_type\"`\n\tPublicIP  string `json:\"PublicIp\" gorm:\"column:public_ip\"`\n\tPrivateIP string `json:\"PrivateIp\" gorm:\"column:ip\"`\n\n\t//规则下发无需管，前端展示用\n\tPortNum          string `json:\"PortNum\" gorm:\"column:port_num\"`\n\tLeakNum          string `json:\"LeakNum\" gorm:\"column:leak_num\"`\n\tResourceGroupNum int    `json:\"ResourceGroupNum\"`\n\tVPCName          string `json:\"VPCName\" gorm:\"column:VPCName\"`\n}",
       "members": [

tccli/services/cfw/v20190904/examples.json

@@ -382,7 +382,7 @@
       {
         "document": "入侵防御规则白名单查询示例",
         "input": "POST / HTTP/1.1\nHost: cfw.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeIdsWhiteRule\n<公共请求参数>\n\n{\n    \"Limit\": 10,\n    \"Offset\": 0\n}",
-        "output": "{\n    \"Response\": {\n        \"RequestId\": \"88db276f-42d5-4b60-afc1-2c5799250a99\",\n        \"ReturnCode\": 0,\n        \"ReturnMsg\": \"success\",\n        \"Total\": 1\n    }\n}",
+        "output": "{\n    \"Response\": {\n        \"Data\": [\n            {\n                \"DstIp\": \"10.23.33.2\",\n                \"FwType\": 4,\n                \"Id\": 63,\n                \"RuleId\": \"20006\",\n                \"SrcIp\": \"10.23.33.1\",\n                \"WhiteRuleType\": \"srcdst\"\n            }\n        ],\n        \"RequestId\": \"88db276f-42d5-4b60-afc1-2c5799250a99\",\n        \"ReturnCode\": 0,\n        \"ReturnMsg\": \"success\",\n        \"Total\": 1\n    }\n}",
         "title": "入侵防御规则白名单查询示例"
       }
     ],

tccli/services/clb/v20180317/api.json

@@ -472,7 +472,7 @@
     "ModifyLoadBalancerMixIpTarget": {
       "document": "修改IPv6FullChain负载均衡7层监听器支持混绑IPv4/IPv6目标特性。",
       "input": "ModifyLoadBalancerMixIpTargetRequest",
-      "name": "修改IPv6FullChain负载均衡7层监听器支持混绑目标特性。",
+      "name": "修改IPv6FullChain负载均衡7层监听器支持混绑目标特性",
       "output": "ModifyLoadBalancerMixIpTargetResponse",
       "status": "online"
     },

tccli/services/ess/v20201111/api.json

@@ -1682,7 +1682,7 @@
         },
         {
           "disabled": false,
-          "document": "**在所有的定位方式下**，控件的扩展参数，为<font color=\"red\">JSON格式</font>，不同类型的控件会有部分非通用参数。\n\n<font color=\"red\">ComponentType为TEXT、MULTI_LINE_TEXT时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体</li>\n<li> <b>FontSize</b>： 范围12 :72</li>\n<li> <b>FontAlign</b>： Left/Right/Center，左对齐/居中/右对齐</li>\n<li> <b>FontColor</b>：字符串类型，格式为RGB颜色数字</li></ul>\n<b>参数样例</b>：`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为FILL_IMAGE时</font>，支持以下参数：\n<ul><li> <b>NotMakeImageCenter</b>：bool。是否设置图片居中。false：居中（默认）。 true : 不居中</li>\n<li> <b>FillMethod</b> : int. 填充方式。0-铺满（默认）；1-等比例缩放</li></ul>\n\n<font color=\"red\">ComponentType为SIGN_SIGNATURE类型时</font>，可以**ComponentTypeLimit**参数控制签署方式\n<ul><li> <b>HANDWRITE</b> : 手写签名</li>\n<li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li>\n<li> <b>ESIGN</b> : 个人印章类型</li>\n<li> <b>SYSTEM_ESIGN</b> : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）</li>\n<li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>\n<b>参考样例</b>：`{\"ComponentTypeLimit\": [\"SYSTEM_ESIGN\"]}`\n印章的对应关系参考下图\n![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)\n\n<font color=\"red\">ComponentType为SIGN_DATE时</font>，支持以下参数：\n<ul><li> <b>Font</b> :字符串类型目前只支持\"黑体\"、\"宋体\"，如果不填默认为\"黑体\"</li>\n<li> <b>FontSize</b> : 数字类型，范围6-72，默认值为12</li>\n<li> <b>FontAlign</b> : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐</li>\n<li> <b>Format</b> : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。</li>\n<li> <b>Gaps</b> : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>\n如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期\n特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）\n<b>参数样例</b>： ` \"{\"Format\":\"yyyy m d\",\"FontSize\":12,\"Gaps\":\"2,2\", \"FontAlign\":\"Right\"}\"`\n\n<font color=\"red\">ComponentType为SIGN_SEAL类型时</font>，支持以下参数：\n<ul><li> <b>PageRanges</b> :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）</li></ul>\n<b>参数样例</b>：` \"{\"PageRange\":[{\"BeginPage\":1,\"EndPage\":-1}]}\"`",
+          "document": "**在所有的定位方式下**，控件的扩展参数，为<font color=\"red\">JSON格式</font>，不同类型的控件会有部分非通用参数。\n\n<font color=\"red\">ComponentType为TEXT、MULTI_LINE_TEXT时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体</li>\n<li> <b>FontSize</b>： 范围12 :72</li>\n<li> <b>FontAlign</b>： Left/Right/Center，左对齐/居中/右对齐</li>\n<li> <b>FontColor</b>：字符串类型，格式为RGB颜色数字</li></ul>\n<b>参数样例</b>：`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为FILL_IMAGE时</font>，支持以下参数：\n<ul><li> <b>NotMakeImageCenter</b>：bool。是否设置图片居中。false：居中（默认）。 true : 不居中</li>\n<li> <b>FillMethod</b> : int. 填充方式。0-铺满（默认）；1-等比例缩放</li></ul>\n\n<font color=\"red\">ComponentType为SIGN_SIGNATURE类型时</font>，可以**ComponentTypeLimit**参数控制签署方式\n<ul><li> <b>HANDWRITE</b> : 手写签名</li>\n<li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li>\n<li> <b>ESIGN</b> : 个人印章类型</li>\n<li> <b>SYSTEM_ESIGN</b> : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）</li>\n<li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>\n<b>参考样例</b>：`{\"ComponentTypeLimit\": [\"SYSTEM_ESIGN\"]}`\n印章的对应关系参考下图\n![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)\n\n<font color=\"red\">ComponentType为SIGN_DATE时</font>，支持以下参数：\n<ul><li> <b>Font</b> :字符串类型目前只支持\"黑体\"、\"宋体\"，如果不填默认为\"黑体\"</li>\n<li> <b>FontSize</b> : 数字类型，范围6-72，默认值为12</li>\n<li> <b>FontAlign</b> : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐</li>\n<li> <b>Format</b> : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。</li>\n<li> <b>Gaps</b> : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>\n如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期\n特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）\n<b>参数样例</b>： ` \"{\"Format\":\"yyyy m d\",\"FontSize\":12,\"Gaps\":\"2,2\", \"FontAlign\":\"Right\"}\"`\n\n<font color=\"red\">ComponentType为SIGN_SEAL类型时</font>，支持以下参数：\n<ul><li> <b>PageRanges</b> :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）</li></ul>\n<b>参数样例</b>：` \"{\"PageRange\":[{\"BeginPage\":1,\"EndPage\":-1}]}\"`\n\n\n<font color=\"red\">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>\n<ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>\n场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置\"IgnoreKeywordError\"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。\n<b>参数样例</b>：` \"{\"IgnoreKeywordError\":1}\"`",
           "example": "无",
           "member": "string",
           "name": "ComponentExtra",