查询数据服务API的发布态信息详情

最近更新时间:2024-10-30 02:25:10

我的收藏

1. 接口描述

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

查询数据服务API的发布态信息

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDataServicePublishedApiDetail。
Version String 公共参数,本接口取值:2021-08-20。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-shanghai, ap-shanghai-fsi, ap-singapore, na-siliconvalley 。
Id String 服务Id
示例值:1847084985566855169
ProjectId String 项目ID

3. 输出参数

参数名称 类型 描述
Data DescribeDataServicePublishedApiDetailResp 服务详情
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询数据服务API的发布态信息响应

查询数据服务API的发布态信息响应示例

输入示例

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

{
    "Id": "1848956796467621890",
    "ProjectId": "1470547050521227264"
}

输出示例

{
    "Response": {
        "Data": {
            "ApiDescription": "",
            "ApiId": "1792441377707995137",
            "ApiName": "test_0520",
            "ApiStatus": 1,
            "ApiTagNames": "",
            "AuthType": 1,
            "GatewayApiUrl": "http://service-xxxxxxx.bj.tencentapigw.cn;https://service-xxxxxxx.bj.tencentapigw.cn",
            "MaxAllowPageSize": 2000,
            "MaxAllowQps": 1,
            "OwnerName": "jaredlin",
            "PathUrl": "/test_0520",
            "RequestError": "{\"code\":\"FailedOperation\",\"message\":\"服务内部发生异常!\",\"requestId\":\"37f66f3c-d9e5-48be-a745-c15eb4b9f41d\"}",
            "RequestExample": "http://service-xxxxxxx.bj.tencentapigw.cn/test_0520?id=1",
            "RequestParam": [
                {
                    "BindField": "id",
                    "DefaultValue": "1",
                    "Description": "记录Id",
                    "ExampleValue": "1",
                    "NonEmpty": 0,
                    "Operator": "=",
                    "ParamName": "id",
                    "ParamPosition": "Query",
                    "ParamType": "Integer"
                }
            ],
            "RequestSuccess": "{\"code\":\"SUCCESS\",\"message\":\"查询成功\",\"data\":{\"totalCount\":1,\"dataSet\":[{\"name123\":\"李四\",\"id\":1}]},\"requestId\":\"94881ebe-01a8-4c45-b2bf-f2175ea2e093\"}",
            "RequestType": "GET",
            "ResponseParam": [
                {
                    "BindField": "name123",
                    "Description": "姓名",
                    "ExampleValue": "李四",
                    "ParamName": "name123",
                    "ParamType": "String"
                },
                {
                    "BindField": "id",
                    "Description": "Id",
                    "ExampleValue": "1",
                    "ParamName": "id",
                    "ParamType": "Integer"
                }
            ],
            "TimeoutPeriod": 5
        },
        "RequestId": "13684205-8efc-479e-9bdd-772c96df6fff"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。