{
  "name": "bi",
  "display_name": "商业智能分析 BI",
  "description": "腾讯云BI API接口",
  "domain": "other",
  "api_version": "2022-01-05",
  "endpoint": "bi.tencentcloudapi.com",
  "actions": [
    {
      "name": "ApplyEmbedInterval",
      "description": "申请延长Token可用时间接口-强鉴权",
      "status": "online",
      "parameters": [
        {
          "name": "ProjectId",
          "type": "integer",
          "required": false,
          "description": "分享项目id",
          "example": "1"
        },
        {
          "name": "PageId",
          "type": "integer",
          "required": false,
          "description": "分享页面id，嵌出看板时此为空值0，ChatBI嵌出时不传",
          "example": "1"
        },
        {
          "name": "BIToken",
          "type": "string",
          "required": false,
          "description": "需要申请延期的Token",
          "example": "1"
        },
        {
          "name": "ExtraParam",
          "type": "string",
          "required": false,
          "description": "备用字段",
          "example": "1"
        },
        {
          "name": "Intention",
          "type": "string",
          "required": false,
          "description": "embed：页面/看板嵌出 chatBIEmbed：ChatBI嵌出",
          "example": "embed"
        },
        {
          "name": "Scope",
          "type": "string",
          "required": false,
          "description": "panel, 看板；page，页面 project，ChatBI嵌出时",
          "example": "page"
        }
      ],
      "required": []
    },
    {
      "name": "ClearEmbedToken",
      "description": "强鉴权token 清理，只有企业管理员才能调用该接口",
      "status": "online",
      "parameters": [
        {
          "name": "ProjectId",
          "type": "string",
          "required": true,
          "description": "项目id",
          "example": "889"
        },
        {
          "name": "UserCorpId",
          "type": "string",
          "required": true,
          "description": "主账号id",
          "example": "700000777778"
        },
        {
          "name": "Scope",
          "type": "string",
          "required": true,
          "description": "panel , page",
          "example": "page"
        },
        {
          "name": "PageId",
          "type": "string",
          "required": false,
          "description": "page id",
          "example": "8991"
        }
      ],
      "required": [
        "ProjectId",
        "UserCorpId",
        "Scope"
      ]
    },
    {
      "name": "CreateDatasource",
      "description": "创建数据源",
      "status": "online",
      "parameters": [
        {
          "name": "DbHost",
          "type": "string",
          "required": true,
          "description": "HOST",
          "example": "192.168.101.1"
        },
        {
          "name": "DbPort",
          "type": "integer",
          "required": true,
          "description": "端口",
          "example": "3306"
        },
        {
          "name": "ServiceType",
          "type": "string",
          "required": true,
          "description": "后端提供字典：域类型，1、腾讯云，2、本地",
          "example": "MYSQL"
        },
        {
          "name": "DbType",
          "type": "string",
          "required": true,
          "description": "驱动 取值范围： MYSQL：MySQL数据库 PRESTO：PRESTO数据库 POSTGRE：PostgreSQL数据库 DLC：DLC数据库 MSSQL：微软SQL Server数据库",
          "example": "MYSQL"
        },
        {
          "name": "Charset",
          "type": "string",
          "required": true,
          "description": "数据库编码",
          "example": "utf8"
        },
        {
          "name": "DbUser",
          "type": "string",
          "required": true,
          "description": "用户名",
          "example": "root"
        },
        {
          "name": "DbPwd",
          "type": "string",
          "required": true,
          "description": "密码",
          "example": "******"
        },
        {
          "name": "DbName",
          "type": "string",
          "required": true,
          "description": "数据库名称",
          "example": "bi_demo"
        },
        {
          "name": "SourceName",
          "type": "string",
          "required": true,
          "description": "数据库别名",
          "example": "腾讯云官方示例数据库"
        },
        {
          "name": "ProjectId",
          "type": "integer",
          "required": true,
          "description": "项目id",
          "example": "1101"
        },
        {
          "name": "Catalog",
          "type": "string",
          "required": false,
          "description": "catalog值",
          "example": "public"
        },
        {
          "name": "DataOrigin",
          "type": "string",
          "required": false,
          "description": "第三方数据源标识",
          "example": "1"
        },
        {
          "name": "DataOriginProjectId",
          "type": "string",
          "required": false,
          "description": "第三方项目id",
          "example": "1"
        },
        {
          "name": "DataOriginDatasourceId",
          "type": "string",
          "required": false,
          "description": "第三方数据源id",
          "example": "1"
        },
        {
          "name": "ExtraParam",
          "type": "string",
          "required": false,
          "description": "扩展参数",
          "example": "1"
        },
        {
          "name": "UniqVpcId",
          "type": "string",
          "required": false,
          "description": "腾讯云私有网络统一标识",
          "example": "1"
        },
        {
          "name": "Vip",
          "type": "string",
          "required": false,
          "description": "私有网络ip",
          "example": "1"
        },
        {
          "name": "Vport",
          "type": "string",
          "required": false,
          "description": "私有网络端口",
          "example": "1150"
        },
        {
          "name": "VpcId",
          "type": "string",
          "required": false,
          "description": "腾讯云私有网络标识",
          "example": "1"
        },
        {
          "name": "OperationAuthLimit",
          "type": "array",
          "required": false,
          "description": "操作权限限制",
          "example": "10",
          "item_type": "string"
        },
        {
          "name": "UseVPC",
          "type": "boolean",
          "required": false,
          "description": "开启vpc",
          "example": "true"
        },
        {
          "name": "RegionId",
          "type": "string",
          "required": false,
          "description": "地域",
          "example": "gz"
        },
        {
          "name": "Schema",
          "type": "string",
          "required": false,
          "description": "数据库schema",
          "example": "DB2INST1"
        },
        {
          "name": "DbVersion",
          "type": "string",
          "required": false,
          "description": "数据库版本",
          "example": "11.5"
        }
      ],
      "required": [
        "DbHost",
        "DbPort",
        "ServiceType",
        "DbType",
        "Charset",
        "DbUser",
        "DbPwd",
        "DbName",
        "SourceName",
        "ProjectId"
      ]
    },
    {
      "name": "CreateDatasourceCloud",
      "description": "创建云数据库",
      "status": "online",
      "parameters": [
        {
          "name": "ServiceType",
          "type": "string",
          "required": true,
          "description": "后端提供字典：域类型，1、腾讯云，2、本地",
          "example": "{\\\"Type\\\":\\\"Own\\\",\\\"IsDefault\\\":true}"
        },
        {
          "name": "DbType",
          "type": "string",
          "required": true,
          "description": "驱动 取值范围： MYSQL：MySQL数据库 PRESTO：PRESTO数据库 POSTGRE：PostgreSQL数据库 DLC：DLC数据库 MSSQL：微软SQL Server数据库",
          "example": "MYSQL"
        },
        {
          "name": "Charset",
          "type": "string",
          "required": true,
          "description": "数据库编码",
          "example": "utf8"
        },
        {
          "name": "DbUser",
          "type": "string",
          "required": true,
          "description": "用户名",
          "example": "root"
        },
        {
          "name": "DbPwd",
          "type": "string",
          "required": true,
          "description": "密码",
          "example": "******"
        },
        {
          "name": "DbName",
          "type": "string",
          "required": true,
          "description": "数据库名称",
          "example": "bi_demo"
        },
        {
          "name": "SourceName",
          "type": "string",
          "required": true,
          "description": "数据库别名",
          "example": "腾讯云BI官方示例数据源"
        },
        {
          "name": "ProjectId",
          "type": "string",
          "required": true,
          "description": "项目ID",
          "example": "1180"
        },
        {
          "name": "Vip",
          "type": "string",
          "required": false,
          "description": "公有云内网ip",
          "example": "1"
        },
        {
          "name": "Vport",
          "type": "string",
          "required": false,
          "description": "公有云内网端口",
          "example": "1"
        },
        {
          "name": "VpcId",
          "type": "string",
          "required": false,
          "description": "vpc标识",
          "example": "1"
        },
        {
          "name": "UniqVpcId",
          "type": "string",
          "required": false,
          "description": "统一vpc标识",
          "example": "1"
        },
        {
          "name": "RegionId",
          "type": "string",
          "required": false,
          "description": "区域标识（gz,bj)",
          "example": "33"
        },
        {
          "name": "ExtraParam",
          "type": "string",
          "required": false,
          "description": "扩展参数",
          "example": "1"
        },
        {
          "name": "InstanceId",
          "type": "string",
          "required": false,
          "description": "实例Id",
          "example": "112"
        },
        {
          "name": "ProdDbName",
          "type": "string",
          "required": false,
          "description": "数据源产品名",
          "example": "bi_demo"
        },
        {
          "name": "DataOrigin",
          "type": "string",
          "required": false,
          "description": "第三方数据源标识",
          "example": "1"
        },
        {
          "name": "DataOriginProjectId",
          "type": "string",
          "required": false,
          "description": "第三方项目id",
          "example": "112"
        },
        {
          "name": "DataOriginDatasourceId",
          "type": "string",
          "required": false,
          "description": "第三方数据源id",
          "example": "11011"
        },
        {
          "name": "ClusterId",
          "type": "string",
          "required": false,
          "description": "集群id",
          "example": "1"
        },
        {
          "name": "Schema",
          "type": "string",
          "required": false,
          "description": "数据库schema",
          "example": "DB2INST1"
        },
        {
          "name": "DbVersion",
          "type": "string",
          "required": false,
          "description": "数据库版本",
          "example": "11.5"
        }
      ],
      "required": [
        "ServiceType",
        "DbType",
        "Charset",
        "DbUser",
        "DbPwd",
        "DbName",
        "SourceName",
        "ProjectId"
      ]
    },
    {
      "name": "CreateEmbedToken",
      "description": "创建嵌出报表-强鉴权",
      "status": "online",
      "parameters": [
        {
          "name": "ProjectId",
          "type": "integer",
          "required": false,
          "description": "分享项目id",
          "example": "117"
        },
        {
          "name": "PageId",
          "type": "integer",
          "required": false,
          "description": "分享页面id，嵌出看板时此为空值0，ChatBI嵌出时不传",
          "example": "11520"
        },
        {
          "name": "Intention",
          "type": "string",
          "required": false,
          "description": "embed表示页面看板嵌出，chatBIEmbed表示ChatBI嵌出",
          "example": "embed"
        },
        {
          "name": "Scope",
          "type": "string",
          "required": false,
          "description": "page表示嵌出页面，panel表示嵌出整个看板，ChatBI嵌出时使用project",
          "example": "page"
        },
        {
          "name": "ExpireTime",
          "type": "string",
          "required": false,
          "description": "过期时间。 单位：分钟 最大值：240。即，4小时 默认值：240",
          "example": "240"
        },
        {
          "name": "ExtraParam",
          "type": "string",
          "required": false,
          "description": "备用字段",
          "example": "1"
        },
        {
          "name": "UserCorpId",
          "type": "string",
          "required": false,
          "description": "使用者企业Id(仅用于多用户)",
          "example": "1120"
        },
        {
          "name": "UserId",
          "type": "string",
          "required": false,
          "description": "使用者Id(仅用于多用户)",
          "example": "219301"
        },
        {
          "name": "TicketNum",
          "type": "integer",
          "required": false,
          "description": "访问次数限制，限制范围1-99999，为空则不设置访问次数限制",
          "example": "10"
        },
        {
          "name": "GlobalParam",
          "type": "string",
          "required": false,
          "description": "全局筛选参数 报表过滤条件的全局参数。 格式为JSON格式的字符串 **目前仅支持字符类型页面参数绑定到全局参数 ** [ { \"ParamKey\": \"name\", //页面参数名称 \"JoinType\": \"AND\", // 连接方式,目前仅支持AND \"WhereList\": [ { \"Operator\": \"-neq\", // 操作符，参考以下说明 \"Value\": [ //操作值，单值数组只传一个值 \"zZWJMD\", \"ZzVGHX\", \"湖南省\", \"河北省\" ] } ] }, { \"ParamKey\": \"genderParam\", \"JoinType\": \"AND\", \"WhereList\": [ { \"Ope...",
          "example": "{\"globalParams\":[{\"field\":\"name\",\"type\":\"string\",}]}"
        },
        {
          "name": "TokenType",
          "type": "integer",
          "required": false,
          "description": "100 不绑定用户, 一次创建一个token，UserCorpId和UserId 非必填，不支持 ChatBI 嵌出 200 单用户单token , 一次创建一个token， UserCorpId和UserId 必填 300 单用户多token, 一次创建多个token，UserCorpId和UserId 必填",
          "example": "100"
        },
        {
          "name": "TokenNum",
          "type": "integer",
          "required": false,
          "description": "一次创建的token数",
          "example": "11"
        },
        {
          "name": "ConfigParam",
          "type": "string",
          "required": false,
          "description": "嵌出显示配置，目前为ChatBI嵌出场景用，TableFilter表示数据表列表过滤，SqlView表示sql查看功能",
          "example": "{\"ChatBIConfigList\":[{\"ConfigType\":\"TableFilter\",\"ConfigDetails\":{\"Values\":[\"123\",\"456\"]}},{\"ConfigType\":\"SqlView\",\"ConfigDetails\":{\"Enabled\":false}}]}"
        }
      ],
      "required": []
    },
    {
      "name": "CreatePermissionRanks",
      "description": "创建行列权限",
      "status": "online",
      "parameters": [
        {
          "name": "TableId",
          "type": "integer",
          "required": false,
          "description": "页数",
          "example": "1"
        },
        {
          "name": "Mode",
          "type": "string",
          "required": false,
          "description": "模式。 取值范围： - ALL：全部 - Specify：指定 - TAG：标签 默认值：ALL 示例值：ALL",
          "example": "ALL"
        },
        {
          "name": "RoleType",
          "type": "string",
          "required": false,
          "description": "角色类型。 取值范围： - ROLES：按角色 - Others：其它 默认值：Others 示例值：Others",
          "example": "Others"
        },
        {
          "name": "RoleId",
          "type": "integer",
          "required": false,
          "description": "所有页码",
          "example": "1"
        },
        {
          "name": "RulerInfo",
          "type": "string",
          "required": false,
          "description": "规则信息",
          "example": "1"
        },
        {
          "name": "Type",
          "type": "string",
          "required": false,
          "description": "类型。 取值范围： - ROW：行权限 - COLUMN：列权限 默认值：ROW 示例值：ROW",
          "example": "ROW"
        },
        {
          "name": "OpenStatus",
          "type": "string",
          "required": false,
          "description": "开启状态。 取值范围： - Open：开启 - Close：关闭 默认值：Close 示例值：Close",
          "example": "Close"
        },
        {
          "name": "ProjectId",
          "type": "integer",
          "required": false,
          "description": "项目id",
          "example": "1"
        },
        {
          "name": "RowColumnConfigList",
          "type": "array",
          "required": false,
          "description": "行列权限配置",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "RulerInfo",
              "type": "string",
              "required": false,
              "description": "行列权限规则 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "{\\\"Logic\\\":\\\"and\\\",\\\"Items\\\":[]}"
            },
            {
              "name": "TagValueList",
              "type": "array",
              "required": false,
              "description": "标签值列表 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "Id",
                  "type": "integer",
                  "required": false,
                  "description": "标签id 注意：此字段可能返回 null，表示取不到有效值。",
                  "example": "1"
                },
                {
                  "name": "Name",
                  "type": "string",
                  "required": false,
                  "description": "标签名称 注意：此字段可能返回 null，表示取不到有效值。",
                  "example": "name"
                },
                {
                  "name": "Values",
                  "type": "array",
                  "required": false,
                  "description": "标签值列表 注意：此字段可能返回 null，表示取不到有效值。",
                  "example": "[\"value1\",\"value2\"]",
                  "item_type": "string"
                }
              ]
            }
          ]
        }
      ],
      "required": []
    },
    {
      "name": "CreateProject",
      "description": "创建项目",
      "status": "online",
      "parameters": [
        {
          "name": "Name",
          "type": "string",
          "required": true,
          "description": "项目名称",
          "example": "1"
        },
        {
          "name": "ColorCode",
          "type": "string",
          "required": true,
          "description": "logo底色",
          "example": "1"
        },
        {
          "name": "Logo",
          "type": "string",
          "required": false,
          "description": "项目Logo",
          "example": "1"
        },
        {
          "name": "Mark",
          "type": "string",
          "required": false,
          "description": "备注",
          "example": "1"
        },
        {
          "name": "IsApply",
          "type": "boolean",
          "required": false,
          "description": "是否允许用户申请",
          "example": "false"
        },
        {
          "name": "DefaultPanelType",
          "type": "integer",
          "required": false,
          "description": "默认看板 取值范围： 1：项目看板 2：我的看板",
          "example": "1(1:项目看板  2：我的看板)"
        },
        {
          "name": "ManagePlatform",
          "type": "string",
          "required": false,
          "description": "管理平台",
          "example": "saas"
        }
      ],
      "required": [
        "Name",
        "ColorCode"
      ]
    },
    {
      "name": "CreateUserRole",
      "description": "创建用户角色",
      "status": "online",
      "parameters": [
        {
          "name": "RoleIdList",
          "type": "array",
          "required": false,
          "description": "角色ID列表",
          "example": "[1101,1102,1103]",
          "item_type": "integer"
        },
        {
          "name": "UserInfoList",
          "type": "array",
          "required": false,
          "description": "用户列表（新）",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户ID",
              "example": "11010"
            },
            {
              "name": "UserName",
              "type": "string",
              "required": false,
              "description": "用户名",
              "example": "zhangsan"
            },
            {
              "name": "Email",
              "type": "string",
              "required": false,
              "description": "邮箱 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "123123***@qq.com"
            },
            {
              "name": "PhoneNumber",
              "type": "string",
              "required": false,
              "description": "手机号 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "+86213***323"
            },
            {
              "name": "AreaCode",
              "type": "string",
              "required": false,
              "description": "手机号区号 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "086"
            },
            {
              "name": "AppUserId",
              "type": "string",
              "required": false,
              "description": "企微账号id 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "1101"
            },
            {
              "name": "AppUserName",
              "type": "string",
              "required": false,
              "description": "企微账号名称 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "zhangsan"
            }
          ]
        },
        {
          "name": "UserGroups",
          "type": "array",
          "required": false,
          "description": "用户组id列表",
          "example": "[123,456]",
          "item_type": "integer"
        }
      ],
      "required": []
    },
    {
      "name": "CreateUserRoleProject",
      "description": "项目内-创建用户角色",
      "status": "online",
      "parameters": [
        {
          "name": "ProjectId",
          "type": "integer",
          "required": false,
          "description": "项目ID",
          "example": "1"
        },
        {
          "name": "RoleIdList",
          "type": "array",
          "required": false,
          "description": "角色ID列表",
          "example": "[1101,1102]",
          "item_type": "integer"
        },
        {
          "name": "UserInfoList",
          "type": "array",
          "required": false,
          "description": "用户列表（新）",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户ID",
              "example": "11010"
            },
            {
              "name": "UserName",
              "type": "string",
              "required": false,
              "description": "用户名",
              "example": "zhangsan"
            },
            {
              "name": "Email",
              "type": "string",
              "required": false,
              "description": "邮箱 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "123123***@qq.com"
            },
            {
              "name": "PhoneNumber",
              "type": "string",
              "required": false,
              "description": "手机号 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "+86213***323"
            },
            {
              "name": "AreaCode",
              "type": "string",
              "required": false,
              "description": "手机号区号 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "086"
            },
            {
              "name": "AppUserId",
              "type": "string",
              "required": false,
              "description": "企微账号id 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "1101"
            },
            {
              "name": "AppUserName",
              "type": "string",
              "required": false,
              "description": "企微账号名称 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "zhangsan"
            }
          ]
        }
      ],
      "required": []
    },
    {
      "name": "DeleteDatasource",
      "description": "删除数据源",
      "status": "online",
      "parameters": [
        {
          "name": "Id",
          "type": "integer",
          "required": true,
          "description": "数据源id",
          "example": "1101010"
        },
        {
          "name": "ProjectId",
          "type": "integer",
          "required": true,
          "description": "项目id",
          "example": "11001"
        }
      ],
      "required": [
        "Id",
        "ProjectId"
      ]
    },
    {
      "name": "DeleteProject",
      "description": "删除项目",
      "status": "online",
      "parameters": [
        {
          "name": "Id",
          "type": "integer",
          "required": true,
          "description": "项目ID",
          "example": "1"
        },
        {
          "name": "Seed",
          "type": "string",
          "required": false,
          "description": "随机数",
          "example": "1"
        },
        {
          "name": "DefaultPanelType",
          "type": "integer",
          "required": false,
          "description": "默认看板 取值范围： 1：项目看板 2：我的看板",
          "example": "page"
        }
      ],
      "required": [
        "Id"
      ]
    },
    {
      "name": "DeleteUserRole",
      "description": "删除用户角色，会删除用户",
      "status": "online",
      "parameters": [
        {
          "name": "UserId",
          "type": "string",
          "required": true,
          "description": "用户ID",
          "example": "1101"
        }
      ],
      "required": [
        "UserId"
      ]
    },
    {
      "name": "DeleteUserRoleProject",
      "description": "项目内-删除用户角色",
      "status": "online",
      "parameters": [
        {
          "name": "ProjectId",
          "type": "integer",
          "required": true,
          "description": "项目ID",
          "example": "1"
        },
        {
          "name": "UserId",
          "type": "string",
          "required": true,
          "description": "用户ID",
          "example": "110101"
        }
      ],
      "required": [
        "ProjectId",
        "UserId"
      ]
    },
    {
      "name": "DescribeDatasourceList",
      "description": "查询数据源列表",
      "status": "online",
      "parameters": [
        {
          "name": "ProjectId",
          "type": "integer",
          "required": true,
          "description": "无",
          "example": "1"
        },
        {
          "name": "AllPage",
          "type": "boolean",
          "required": false,
          "description": "返回所有页面，默认false",
          "example": "false"
        },
        {
          "name": "DbName",
          "type": "string",
          "required": false,
          "description": "数据库名称检索",
          "example": "示例数据库"
        },
        {
          "name": "PageNo",
          "type": "integer",
          "required": false,
          "description": "无",
          "example": "1"
        },
        {
          "name": "PageSize",
          "type": "integer",
          "required": false,
          "description": "无",
          "example": "1"
        },
        {
          "name": "Keyword",
          "type": "string",
          "required": false,
          "description": "搜索关键词",
          "example": "示例数据库"
        },
        {
          "name": "PermissionType",
          "type": "integer",
          "required": false,
          "description": "过滤无权限列表的参数（0 全量，1 使用权限，2 编辑权限）",
          "example": "1"
        }
      ],
      "required": [
        "ProjectId"
      ]
    },
    {
      "name": "DescribePageWidgetList",
      "description": "查询页面组件信息",
      "status": "online",
      "parameters": [
        {
          "name": "ProjectId",
          "type": "string",
          "required": true,
          "description": "项目id",
          "example": "1101"
        },
        {
          "name": "PageId",
          "type": "string",
          "required": true,
          "description": "页面id",
          "example": "1"
        }
      ],
      "required": [
        "ProjectId",
        "PageId"
      ]
    },
    {
      "name": "DescribePermissionRanksInfo",
      "description": "根据角色或标签查询行列权限配置",
      "status": "online",
      "parameters": [
        {
          "name": "TableId",
          "type": "integer",
          "required": false,
          "description": "页数",
          "example": "1"
        },
        {
          "name": "Mode",
          "type": "string",
          "required": false,
          "description": "模式。 取值范围： - ALL：全部 - Specify：指定 - TAG：标签 默认值：ALL 示例值：ALL",
          "example": "ALL"
        },
        {
          "name": "RoleType",
          "type": "string",
          "required": false,
          "description": "角色类型。 取值范围： - ROLES：按角色 - Others：其它 默认值：Others 示例值：Others",
          "example": "Others"
        },
        {
          "name": "RoleId",
          "type": "integer",
          "required": false,
          "description": "所有页码",
          "example": "1"
        },
        {
          "name": "Type",
          "type": "string",
          "required": false,
          "description": "类型。 取值范围： - ROW：行权限 - COLUMN：列权限 默认值：ROW 示例值：ROW",
          "example": "ROW"
        },
        {
          "name": "ProjectId",
          "type": "integer",
          "required": false,
          "description": "项目id",
          "example": "125"
        }
      ],
      "required": []
    },
    {
      "name": "DescribePermissionRoleInfo",
      "description": "行列权限项目内角色列表接口1",
      "status": "online",
      "parameters": [
        {
          "name": "ProjectId",
          "type": "integer",
          "required": true,
          "description": "项目ID",
          "example": "1"
        },
        {
          "name": "PageNo",
          "type": "integer",
          "required": false,
          "description": "页数",
          "example": "1"
        },
        {
          "name": "PageSize",
          "type": "integer",
          "required": false,
          "description": "条数",
          "example": "1"
        },
        {
          "name": "AllPage",
          "type": "boolean",
          "required": false,
          "description": "所有页码",
          "example": "true"
        }
      ],
      "required": [
        "ProjectId"
      ]
    },
    {
      "name": "DescribePermissionStatusInfo",
      "description": "查询行列权限初始状态1",
      "status": "online",
      "parameters": [
        {
          "name": "TableId",
          "type": "integer",
          "required": false,
          "description": "页数",
          "example": "1"
        },
        {
          "name": "Type",
          "type": "string",
          "required": false,
          "description": "类型。 取值范围： - ROW：行权限 - COLUMN：列权限 默认值：ROW 示例值：ROW",
          "example": "ROW"
        },
        {
          "name": "ProjectId",
          "type": "string",
          "required": false,
          "description": "1",
          "example": "1"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeProjectInfo",
      "description": "项目详情接口",
      "status": "online",
      "parameters": [
        {
          "name": "Id",
          "type": "integer",
          "required": true,
          "description": "项目Id",
          "example": "1"
        },
        {
          "name": "DefaultPanelType",
          "type": "integer",
          "required": false,
          "description": "默认看板 取值范围： 1：项目看板 2：我的看板",
          "example": "1"
        }
      ],
      "required": [
        "Id"
      ]
    },
    {
      "name": "DescribeProjectList",
      "description": "项目信息",
      "status": "online",
      "parameters": [
        {
          "name": "PageSize",
          "type": "integer",
          "required": false,
          "description": "页容，初版默认20，将来可能根据屏幕宽度动态变化",
          "example": "1"
        },
        {
          "name": "PageNo",
          "type": "integer",
          "required": false,
          "description": "页标",
          "example": "1"
        },
        {
          "name": "Keyword",
          "type": "string",
          "required": false,
          "description": "检索模糊字段",
          "example": "1"
        },
        {
          "name": "AllPage",
          "type": "boolean",
          "required": false,
          "description": "是否全部展示，如果是ture，则忽略分页",
          "example": "false"
        },
        {
          "name": "ModuleCollection",
          "type": "string",
          "required": false,
          "description": "角色信息",
          "example": "bi_read"
        },
        {
          "name": "ModuleIdList",
          "type": "array",
          "required": false,
          "description": "moduleId集合",
          "example": "[“111”]",
          "item_type": "string"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeUserProjectList",
      "description": "项目内-用户接口",
      "status": "online",
      "parameters": [
        {
          "name": "ProjectId",
          "type": "integer",
          "required": false,
          "description": "项目ID",
          "example": "1101"
        },
        {
          "name": "AllPage",
          "type": "boolean",
          "required": false,
          "description": "无",
          "example": "false"
        },
        {
          "name": "PageNo",
          "type": "integer",
          "required": false,
          "description": "无",
          "example": "1"
        },
        {
          "name": "PageSize",
          "type": "integer",
          "required": false,
          "description": "无",
          "example": "10"
        },
        {
          "name": "IsFilterPerAuthUser",
          "type": "boolean",
          "required": false,
          "description": "是否过滤掉企业管理员",
          "example": "false"
        },
        {
          "name": "IsFilterCurrentUser",
          "type": "boolean",
          "required": false,
          "description": "是否过滤掉当前用户",
          "example": "false"
        },
        {
          "name": "Keyword",
          "type": "string",
          "required": false,
          "description": "关键字",
          "example": "zhangsan"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeUserRoleList",
      "description": "用户角色列表",
      "status": "online",
      "parameters": [
        {
          "name": "PageNo",
          "type": "integer",
          "required": true,
          "description": "页码",
          "example": "1"
        },
        {
          "name": "PageSize",
          "type": "integer",
          "required": true,
          "description": "页数",
          "example": "10"
        },
        {
          "name": "AllPage",
          "type": "boolean",
          "required": false,
          "description": "全部页码",
          "example": "true"
        },
        {
          "name": "UserType",
          "type": "string",
          "required": false,
          "description": "0 企业用户 1 访客 不填表示所有用户",
          "example": "0"
        },
        {
          "name": "Keyword",
          "type": "string",
          "required": false,
          "description": "模糊搜索的关键字",
          "example": "zhangsan"
        },
        {
          "name": "ProjectId",
          "type": "string",
          "required": false,
          "description": "项目id",
          "example": "1101"
        },
        {
          "name": "IsOnlyBindAppUser",
          "type": "boolean",
          "required": false,
          "description": "是否只获取绑定企微应用的",
          "example": "true"
        }
      ],
      "required": [
        "PageNo",
        "PageSize"
      ]
    },
    {
      "name": "DescribeUserRoleProjectList",
      "description": "项目内-用户角色列表",
      "status": "online",
      "parameters": [
        {
          "name": "PageNo",
          "type": "integer",
          "required": true,
          "description": "页码",
          "example": "1"
        },
        {
          "name": "PageSize",
          "type": "integer",
          "required": true,
          "description": "页数",
          "example": "10"
        },
        {
          "name": "ProjectId",
          "type": "integer",
          "required": true,
          "description": "项目ID",
          "example": "11202"
        },
        {
          "name": "IsOnlyBindAppUser",
          "type": "boolean",
          "required": false,
          "description": "是否只获取绑定企微应用的",
          "example": "true"
        },
        {
          "name": "AllPage",
          "type": "boolean",
          "required": false,
          "description": "是否获取全部数据",
          "example": "false"
        },
        {
          "name": "RoleCode",
          "type": "string",
          "required": false,
          "description": "角色编码",
          "example": "sys_project_admin"
        },
        {
          "name": "UserIdList",
          "type": "array",
          "required": false,
          "description": "用户id列表",
          "example": "[\"1111\",\"2222\"]",
          "item_type": "string"
        },
        {
          "name": "Keyword",
          "type": "string",
          "required": false,
          "description": "搜索关键词",
          "example": "搜索关键词"
        }
      ],
      "required": [
        "PageNo",
        "PageSize",
        "ProjectId"
      ]
    },
    {
      "name": "ExportScreenPage",
      "description": "页面截图导出",
      "status": "online",
      "parameters": [
        {
          "name": "ProjectId",
          "type": "string",
          "required": true,
          "description": "项目id",
          "example": "110101"
        },
        {
          "name": "PageId",
          "type": "string",
          "required": true,
          "description": "页面id",
          "example": "1"
        },
        {
          "name": "CanvasType",
          "type": "string",
          "required": false,
          "description": "画布类型。栅格画布：GRID；自由画布：FREE",
          "example": "\"GRID\""
        },
        {
          "name": "PicType",
          "type": "string",
          "required": false,
          "description": "图片导出类型。base64；url（有效期：1天）",
          "example": "\"base64\""
        },
        {
          "name": "WidgetIds",
          "type": "array",
          "required": false,
          "description": "组件Ids。为空时，导出整个页面",
          "example": "[\"123\",\"456\"]",
          "item_type": "string"
        },
        {
          "name": "AsyncRequest",
          "type": "boolean",
          "required": false,
          "description": "是否是异步请求",
          "example": "true"
        },
        {
          "name": "TranId",
          "type": "string",
          "required": false,
          "description": "事务id",
          "example": "dsa21192912"
        }
      ],
      "required": [
        "ProjectId",
        "PageId"
      ]
    },
    {
      "name": "ModifyDatasource",
      "description": "更新数据源",
      "status": "online",
      "parameters": [
        {
          "name": "DbHost",
          "type": "string",
          "required": true,
          "description": "HOST",
          "example": "1"
        },
        {
          "name": "DbPort",
          "type": "integer",
          "required": true,
          "description": "端口",
          "example": "1"
        },
        {
          "name": "ServiceType",
          "type": "string",
          "required": true,
          "description": "后端提供字典：域类型，1、腾讯云，2、本地",
          "example": "1"
        },
        {
          "name": "DbType",
          "type": "string",
          "required": true,
          "description": "驱动 取值范围： MYSQL：MySQL数据库 PRESTO：PRESTO数据库 POSTGRE：PostgreSQL数据库 DLC：DLC数据库 MSSQL：微软SQL Server数据库",
          "example": "1"
        },
        {
          "name": "Charset",
          "type": "string",
          "required": true,
          "description": "数据库编码",
          "example": "1"
        },
        {
          "name": "DbUser",
          "type": "string",
          "required": true,
          "description": "用户名",
          "example": "1"
        },
        {
          "name": "DbPwd",
          "type": "string",
          "required": true,
          "description": "密码",
          "example": "1"
        },
        {
          "name": "DbName",
          "type": "string",
          "required": true,
          "description": "数据库名称",
          "example": "1"
        },
        {
          "name": "SourceName",
          "type": "string",
          "required": true,
          "description": "数据库别名",
          "example": "1"
        },
        {
          "name": "Id",
          "type": "integer",
          "required": true,
          "description": "数据源id",
          "example": "1"
        },
        {
          "name": "ProjectId",
          "type": "integer",
          "required": true,
          "description": "项目ID",
          "example": "1"
        },
        {
          "name": "Catalog",
          "type": "string",
          "required": false,
          "description": "catalog值",
          "example": "presto catalog"
        },
        {
          "name": "DataOrigin",
          "type": "string",
          "required": false,
          "description": "第三方数据源标识",
          "example": "ssa"
        },
        {
          "name": "DataOriginProjectId",
          "type": "string",
          "required": false,
          "description": "第三方项目id",
          "example": "1021"
        },
        {
          "name": "DataOriginDatasourceId",
          "type": "string",
          "required": false,
          "description": "第三方数据源id",
          "example": "2129"
        },
        {
          "name": "ExtraParam",
          "type": "string",
          "required": false,
          "description": "扩展参数",
          "example": "{\"xx\":\"wq\"}"
        },
        {
          "name": "UniqVpcId",
          "type": "string",
          "required": false,
          "description": "腾讯云私有网络统一标识",
          "example": "1"
        },
        {
          "name": "Vip",
          "type": "string",
          "required": false,
          "description": "私有网络ip",
          "example": "1"
        },
        {
          "name": "Vport",
          "type": "string",
          "required": false,
          "description": "私有网络端口",
          "example": "920"
        },
        {
          "name": "VpcId",
          "type": "string",
          "required": false,
          "description": "腾讯云私有网络标识",
          "example": "1"
        },
        {
          "name": "UseVPC",
          "type": "boolean",
          "required": false,
          "description": "开启vpc",
          "example": "true"
        },
        {
          "name": "RegionId",
          "type": "string",
          "required": false,
          "description": "地域",
          "example": "gz\t"
        },
        {
          "name": "Schema",
          "type": "string",
          "required": false,
          "description": "数据库schema",
          "example": "DB2INST1"
        },
        {
          "name": "DbVersion",
          "type": "string",
          "required": false,
          "description": "数据库版本",
          "example": "11.5"
        }
      ],
      "required": [
        "DbHost",
        "DbPort",
        "ServiceType",
        "DbType",
        "Charset",
        "DbUser",
        "DbPwd",
        "DbName",
        "SourceName",
        "Id",
        "ProjectId"
      ]
    },
    {
      "name": "ModifyDatasourceCloud",
      "description": "更新云数据库",
      "status": "online",
      "parameters": [
        {
          "name": "ServiceType",
          "type": "string",
          "required": true,
          "description": "后端提供字典：域类型，1、腾讯云，2、本地",
          "example": "1"
        },
        {
          "name": "DbType",
          "type": "string",
          "required": true,
          "description": "驱动 取值范围： MYSQL：MySQL数据库 PRESTO：PRESTO数据库 POSTGRE：PostgreSQL数据库 DLC：DLC数据库 MSSQL：微软SQL Server数据库",
          "example": "1"
        },
        {
          "name": "Charset",
          "type": "string",
          "required": true,
          "description": "数据库编码",
          "example": "1"
        },
        {
          "name": "DbUser",
          "type": "string",
          "required": true,
          "description": "用户名",
          "example": "1"
        },
        {
          "name": "DbPwd",
          "type": "string",
          "required": true,
          "description": "密码",
          "example": "1"
        },
        {
          "name": "DbName",
          "type": "string",
          "required": true,
          "description": "数据库名称",
          "example": "1"
        },
        {
          "name": "SourceName",
          "type": "string",
          "required": true,
          "description": "数据库别名",
          "example": "1"
        },
        {
          "name": "ProjectId",
          "type": "string",
          "required": true,
          "description": "项目ID",
          "example": "1"
        },
        {
          "name": "Id",
          "type": "integer",
          "required": true,
          "description": "住键",
          "example": "1"
        },
        {
          "name": "Vip",
          "type": "string",
          "required": false,
          "description": "公有云内网ip",
          "example": "1"
        },
        {
          "name": "Vport",
          "type": "string",
          "required": false,
          "description": "公有云内网端口",
          "example": "1"
        },
        {
          "name": "VpcId",
          "type": "string",
          "required": false,
          "description": "vpc标识",
          "example": "1"
        },
        {
          "name": "UniqVpcId",
          "type": "string",
          "required": false,
          "description": "统一vpc标识",
          "example": "1"
        },
        {
          "name": "RegionId",
          "type": "string",
          "required": false,
          "description": "区域标识（gz,bj)",
          "example": "1"
        },
        {
          "name": "ExtraParam",
          "type": "string",
          "required": false,
          "description": "扩展参数",
          "example": "1"
        },
        {
          "name": "InstanceId",
          "type": "string",
          "required": false,
          "description": "实例id",
          "example": "1"
        },
        {
          "name": "ProdDbName",
          "type": "string",
          "required": false,
          "description": "数据源产品名",
          "example": "1"
        },
        {
          "name": "DataOrigin",
          "type": "string",
          "required": false,
          "description": "第三方数据源标识",
          "example": "21021"
        },
        {
          "name": "DataOriginProjectId",
          "type": "string",
          "required": false,
          "description": "第三方项目id",
          "example": "1311"
        },
        {
          "name": "DataOriginDatasourceId",
          "type": "string",
          "required": false,
          "description": "第三方数据源id",
          "example": "213313"
        },
        {
          "name": "ClusterId",
          "type": "string",
          "required": false,
          "description": "集群id",
          "example": "46"
        },
        {
          "name": "Schema",
          "type": "string",
          "required": false,
          "description": "数据库schema",
          "example": "DB2INST1"
        },
        {
          "name": "DbVersion",
          "type": "string",
          "required": false,
          "description": "数据库版本",
          "example": "11.5"
        }
      ],
      "required": [
        "ServiceType",
        "DbType",
        "Charset",
        "DbUser",
        "DbPwd",
        "DbName",
        "SourceName",
        "ProjectId",
        "Id"
      ]
    },
    {
      "name": "ModifyProject",
      "description": "修改项目信息",
      "status": "online",
      "parameters": [
        {
          "name": "Id",
          "type": "integer",
          "required": true,
          "description": "项目Id",
          "example": "50"
        },
        {
          "name": "Name",
          "type": "string",
          "required": false,
          "description": "名字",
          "example": "云数据源"
        },
        {
          "name": "ColorCode",
          "type": "string",
          "required": false,
          "description": "颜色值",
          "example": "#ffffff"
        },
        {
          "name": "Logo",
          "type": "string",
          "required": false,
          "description": "图标",
          "example": "log.png"
        },
        {
          "name": "Mark",
          "type": "string",
          "required": false,
          "description": "备注",
          "example": "备注"
        },
        {
          "name": "IsApply",
          "type": "boolean",
          "required": false,
          "description": "可申请",
          "example": "false"
        },
        {
          "name": "Seed",
          "type": "string",
          "required": false,
          "description": "种子",
          "example": "\"12355\""
        },
        {
          "name": "DefaultPanelType",
          "type": "integer",
          "required": false,
          "description": "默认看板 取值范围： 1：项目看板 2：我的看板",
          "example": "1"
        },
        {
          "name": "PanelScope",
          "type": "string",
          "required": false,
          "description": "2",
          "example": "ALL"
        },
        {
          "name": "ManagePlatform",
          "type": "string",
          "required": false,
          "description": "项目管理平台",
          "example": "saas"
        }
      ],
      "required": [
        "Id"
      ]
    },
    {
      "name": "ModifyUserRole",
      "description": "修改用户角色信息",
      "status": "online",
      "parameters": [
        {
          "name": "UserId",
          "type": "string",
          "required": false,
          "description": "用户ID",
          "example": "120120"
        },
        {
          "name": "RoleIdList",
          "type": "array",
          "required": false,
          "description": "角色ID 列表",
          "example": "[2121,231,342]",
          "item_type": "integer"
        },
        {
          "name": "Email",
          "type": "string",
          "required": false,
          "description": "邮箱",
          "example": "123***@qq.com"
        },
        {
          "name": "UserName",
          "type": "string",
          "required": false,
          "description": "用户名",
          "example": "zhangsan"
        },
        {
          "name": "PhoneNumber",
          "type": "string",
          "required": false,
          "description": "手机号",
          "example": "861212***211"
        },
        {
          "name": "AreaCode",
          "type": "string",
          "required": false,
          "description": "手机区号",
          "example": "086"
        },
        {
          "name": "AppUserId",
          "type": "string",
          "required": false,
          "description": "企业微信应用用户id",
          "example": "12012"
        },
        {
          "name": "LoginSecurityStatus",
          "type": "integer",
          "required": false,
          "description": "是否开启手机验证码登录（0 关闭，1 开启）",
          "example": "0"
        },
        {
          "name": "ResetPassWordTip",
          "type": "integer",
          "required": false,
          "description": "是否开启密码过期提醒（0 关闭，1 开启",
          "example": "0"
        },
        {
          "name": "ForceResetPassWord",
          "type": "integer",
          "required": false,
          "description": "强制修改密码（0 关闭，1 开启）",
          "example": "0"
        },
        {
          "name": "PasswordExpired",
          "type": "integer",
          "required": false,
          "description": "密码过期提醒时间，30、60、90（默认）、180天",
          "example": "90"
        }
      ],
      "required": []
    },
    {
      "name": "ModifyUserRoleProject",
      "description": "项目-修改用户角色信息",
      "status": "online",
      "parameters": [
        {
          "name": "ProjectId",
          "type": "integer",
          "required": false,
          "description": "项目ID",
          "example": "1"
        },
        {
          "name": "UserId",
          "type": "string",
          "required": false,
          "description": "用户ID",
          "example": "12021"
        },
        {
          "name": "RoleIdList",
          "type": "array",
          "required": false,
          "description": "角色ID 列表",
          "example": "[122,3213,34]",
          "item_type": "integer"
        },
        {
          "name": "Email",
          "type": "string",
          "required": false,
          "description": "邮箱",
          "example": "123***@qq.com"
        },
        {
          "name": "UserName",
          "type": "string",
          "required": false,
          "description": "用户名",
          "example": "zhangsan"
        },
        {
          "name": "AppUserId",
          "type": "string",
          "required": false,
          "description": "企业微信应用用户id",
          "example": "32013"
        }
      ],
      "required": []
    }
  ]
}