接口说明

最近更新时间:11/9/2023, 4:22:23 PM作者:andrewren(任豪)

平台的接口类型有2种,分别是:OpenAPI、HttpAPI

  1. OpenAPI:腾讯云云API 3.0规范风格。
  2. 非OpenAPI:平台原始http接口风格(正在陆续迁移到云OpenAPI模式,但部分还没迁移完成)。

OpenAPI

OpenAPI是工业云平台统一的提供对外调用的,风格、规范与腾讯公有云云API 3.0 保持一致的接口。

有如下特点:

  1. 接口返回格式:

正常返回格式:

{
    "Response": {
        "InstanceIdSet": [
            "xxx1",
            "xxx2"
        ],
        "RequestId": "eac6b301-a322-493a-8e36-83b295459397"
    }
}

异常返回格式:

{
    "Response": {
        "Error": {
            "Code": "AuthFailure",
            "Message": "qcloud was not able to validate the provided access credentials"
        },
        "RequestId": "eac6b301-a322-493a-8e36-83b295459397"
    }
}
  1. 签名参考腾讯云API v3签名方法:https://cloud.tencent.com/document/product/628/45174
  2. 错误码
  3. HTTP Header:
    • X-TC-Token
    • X-TC-Action
    • X-TC-Version
    • X-TC-Timestamp
    • X-TC-Region
    • Host
    • Authorization
  4. 可复用 腾讯云 API SDK

推荐使用腾讯云 API 配套的7种常见的编程语言 SDK,已经封装了签名和请求过程,均已开源。

SDK

工业云提供了SDK供使用(暂时仅有Java、Go),也可使用腾讯云官网SDK来进行工业云接口调用。

工业云开放接口使用腾讯云云 API 规范,第三方调用工业云平台开放接口使用SDK,首先须向平台方申请第三方应用独立的 SecretId 与 SecretKey。

工业云SDK

目前提供go、java版本SDK,已封装好工业云openAPI,直接使用即可。具体详细阅读下面内容。

腾讯云SDK

从github中下载TencentCloud对应语言的的SDK: https://github.com/TencentCloud

使用方式可参考使用腾讯云SDK调用OpenAPI示例

非OpenAPI

平台原始http接口风格(正在陆续迁移到OpenAPI模式,但部分还没迁移完成)。

目前提供此类型接口的主要是账号中的部分接口。