数据开发治理平台 WeData 查询代码模版具体详情

1. 接口描述

接口请求域名： wedata.tencentcloudapi.com 。

查询代码模版具体详情

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeCodeTemplateDetail。
Version	是	String	公共参数，本接口取值：2021-08-20。
Region	是	String	公共参数，详见产品支持的地域列表。
ProjectId	是	String	项目Id 示例值：1470547050521227264
CodeTemplateId	是	String	模版Id 示例值：20250227112841503
NeedReturnScriptContent	否	Boolean	是否需要返回脚本内容，默认false。示例值：false

3. 输出参数

参数名称	类型	描述
Data	CodeTemplateDetail	代码详情注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查看代码模版详情

查看代码模版详情

输入示例

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

{
    "CodeTemplateId": "20250311155509313",
    "ProjectId": "1470547050521227264"
}

输出示例

{
    "Response": {
        "Data": {
            "BrokerIp": "any",
            "CodeTemplateDesc": null,
            "CodeTemplateId": "20250311155509313",
            "CodeTemplateName": "copy11",
            "Ext": {
                "DryRunExtAttributes": null,
                "DryRunParameter": null,
                "Properties": [
                    {
                        "ParamKey": "bucket",
                        "ParamValue": "wedata-fusion-dev-1257305158"
                    },
                    {
                        "ParamKey": "ftp.file.name",
                        "ParamValue": "/datastudio/codeTemplate/1470547050521227264/copy11.py"
                    },
                    {
                        "ParamKey": "region",
                        "ParamValue": "ap-nanjing"
                    }
                ],
                "TaskId": "20250311155509313"
            },
            "FolderId": "",
            "FolderName": "",
            "InCharge": "kevinnie",
            "InChargeId": "100028578763",
            "LastUpdateTime": "2025-03-11 15:55:09",
            "ProjectId": "1470547050521227264",
            "ResourceGroup": null,
            "ScriptChange": true,
            "Submit": false,
            "TaskType": 30,
            "UpdateUser": "kevinnie",
            "UpdateUserId": "100028578763"
        },
        "RequestId": "9b5e61e9-0575-4c1e-9103-c1a1be7efc11"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation	操作失败。
InvalidParameter.ClientIpNotAuthorized	ClientIp未被授权。