创建免密分享

最近更新时间:2024-08-28 01:22:45

我的收藏

1. 接口描述

接口请求域名: cls.tencentcloudapi.com 。

创建控制台分享

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateConsoleSharing。
Version String 公共参数,本接口取值:2020-10-16。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-mumbai, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley 。
SharingConfig ConsoleSharingConfig 免密分享配置

3. 输出参数

参数名称 类型 描述
SharingUrl String 免密分享链接
示例值:https://clsshare.tencent-cloud.com/s/13cez28h
SharingId String 免密分享链接ID
示例值:13cez28h
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建控制台匿名分享请求示例

创建控制台检索页/仪表盘免登陆分享站点

输入示例

POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateConsoleSharing
<公共请求参数>

{
    "SharingConfig": {
        "Name": "my-sharing",
        "Type": 1,
        "VerifyCode": "lEC0V0",
        "DurationMilliseconds": 1800000,
        "NowTime": 1706787306086,
        "IsLockTimeRange": true,
        "IsLockQuery": true,
        "Params": [
            {
                "Name": "query"
            }
        ],
        "Resources": [
            "qcs::cls:ap-guangzhou:uin/10000000001:topic/c1306921-2180-3e45-9azb-31d12217871e6"
        ]
    }
}

输出示例

{
    "Response": {
        "SharingUrl": "https://clsshare.tencent-cloud.com/s/13cez28h",
        "SharingId": "13cez28h",
        "RequestId": "714cf720-43e9-460b-bd9a-42a193ca3d94"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。