展开

关键词

首页关键词api接口实例

api接口实例

API(ApplicationProgrammingInterface,应用程序编程接口)是一些预先定义的函数,目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力,而又无需访问源码,或理解内部工作机制的细节。

相关内容

云 API

云 API

云 API 是腾讯云开放生态的基石。通过云 API,只需执行对应 API 命令行工具即可快速操作云产品;在熟练的情况下,使用一些频繁使用的功能,使用云 API 可以极大的提高效率;除此之外,通过API可以组合功能,实现更高级的功能,易于自动化, 易于远程调用, 兼容性强,对系统要求低。
  • 云 API

    词汇表,产品概述,购买指南,API 使用问题,SDK 使用问题,入门必读,使用 API Explorer,使用 TCCLI,C++ API,.NET API,GO API,Java API,Node.jsAPI,PHP API,Python API,应用场景,使用腾讯云 API 平台,使用 API Inspector,使用云 API 控制台,查询产品可用区列表,查询产品支持的地域列表,数据结构,请求结构API Explorer,使用 TCCLI,C++ API,.NET API,GO API,Java API,Node.js API,PHP API,Python API,产品简介,应用场景,使用腾讯云API 平台,使用 API Inspector,使用云 API 控制台,API 文档,API控制台相关接口,查询产品可用区列表,查询产品支持的地域列表,数据结构,调用方式,请求结构,公共参数,签名方法v3,签名方法,返回结果,错误码,简介,API 概览,更新历史,地域相关接口,联系我们
    来自:
  • 使用腾讯云 API 平台

    概述腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。提供 API Explorer 在线调试中心,API 中心,SDK 中心等工具及资源入口。提供云 API 产品的接口发布动态,可查看产品 API 最新发布情况。例如,可查看接口变更的参数以及数据结构等。 使用多形式检索腾讯云 API 平台 支持使用 API 名称、错误码或产品名称中英文多种形式进行检索。您可在输入框中输入需检索的中英文信息,即可通过下拉框的展示信息查看 API 接口文档或前往该 API 在线调试页面。如下图所示: API文档:您可查看 API 接口文档或进入该 API 的在线调试页面。错误码:您可进入对应错误码详情页面,查看产品名、错误码及错误码说明。
    来自:
  • 广告
    关闭

    腾讯「技术创作101训练营」第三季上线!

    快来报名!

  • 您找到你想要的搜索结果了吗?
    是的
    没有找到
  • 使用云 API 控制台

    云 API 控制台 提供了用户查看调用产品情况的可视化界面,方便用户了解腾讯云 API 调用次数、错误率、使用 API 调用的产品分布以及错误码分布。注意: 云 API 控制台仅展示您使用 API 3.0调用的数据情况(包括 API Explorer、TCCLI 及 SDK 调用),不包括控制台关联的 API 调用。查看 API 调用概览您可通过云 API 控制台概览页查看以下信息: 可查看1小时、24小时、7天或30天内的 API 调用次数及错误率分布情况。如下图所示: 使用 API 库您可选择云 API 控制台左侧导航栏中的【API库】,进入产品 API 文档库查看对应文档。也可直接使用腾讯云 API 平台,详情请参见 使用腾讯云 API 平台。腾讯云 API Explorer 工具 是一款自动化工具,目前已支持云服务器 CVM、私有网络 VPC、云硬盘 CBS 等 腾讯云产品 的 API 接口调用自动化。
    来自:
  • 使用 API Inspector

    API Inspector 是云 API 新推出的一款产品功能,用户可通过此功能查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试注意 API Inspector 仅展示公开的 云 API 3.0 接口信息。API Inspector 已在腾讯云多款产品控制台上开放,详情请参见 支持产品列表。如下图所示: 自动录制 API 调用本文以修改实例名称为例,介绍 API Inspector 的自动录制功能: 将某个实例名称修改为 API Inspector,具体操作请参见 修改实例名称。开启 API Inspector 功能,即可查看涉及改名操作的所有 API 调用。如下图所示:您可勾选“隐藏Describe类接口”,查看功能核心接口。可选择复制对应格式的代码段,如下图所示:API Explorer 在线调试您可选择 或【前往API Explorer】,使用 API Explorer 工具直接调试对应的功能,也可选择 查看对应接口文档
    来自:
  • API 使用问题

    当出现 Socket error 10060 - Connection timed out 错误码提示时,实际是 Socket 编程接口给出的错误,表示网络连接超时。您的机器将无法和腾讯云云 API 服务器进行连通,请排查以下问题: 本地访问外网是否需要设置代理。本地机器防火墙是否有限制外访的规则。路由器是否有限制外访的规则。 腾讯云 API 的错误码有哪些?腾讯云 API 的错误码通常分为公共错误码和非公共错误码: 公共错误码:可前往各产品文档中的【API 文档】>【调用方式】>【返回结果】,在返回结果文档中进行查看。非公共错误码:可在具体的接口文档中查看,例如 创建实例 接口的错误码。
    来自:
  • PHP API

    腾讯云 API 全新升级3.0 ,该版本进行了性能优化且全地域部署、支持就近和按地域接入、访问时延下降显著,接口描述更加详细、错误码描述更加全面、SDK 增加接口级注释,让您更加方便快捷的使用腾讯云产品通信协议 腾讯云 API 的所有接口均通过 HTTPS 进行通信,提供高安全性的通信通道。 3.参数名称类型必选描述 ActionString是操作的接口名称。取值参考接口文档中输入参数公共参数 Action 的说明。例如云服务器的查询实例列表接口,取值为 DescribeInstances。下面以 查看实例列表 接口为例,分步骤介绍签名的计算过程。请求主机:查看实例列表(DescribeInstances)的请求域名为:cvm.tencentcloudapi.com 。实际的请求域名根据接口所属模块的不同而不同,详见各接口说明。
    来自:
  • Python API

    腾讯云 API 全新升级3.0 ,该版本进行了性能优化且全地域部署、支持就近和按地域接入、访问时延下降显著,接口描述更加详细、错误码描述更加全面、SDK 增加接口级注释,让您更加方便快捷的使用腾讯云产品通信协议 腾讯云 API 的所有接口均通过 HTTPS 进行通信,提供高安全性的通信通道。 3.参数名称类型必选描述 ActionString是操作的接口名称。取值参考接口文档中输入参数公共参数 Action 的说明。例如云服务器的查询实例列表接口,取值为 DescribeInstances。下面以 查看实例列表 接口为例,分步骤介绍签名的计算过程。我们选择该接口原因是: 云服务器默认已开通,该接口很常用。该接口是只读的,不会改变现有资源的状态。请求主机:查看实例列表(DescribeInstances)的请求域名为:cvm.tencentcloudapi.com。实际的请求域名根据接口所属模块的不同而不同,详见各接口说明。
    来自:
  • GO API

    腾讯云 API 全新升级3.0 ,该版本进行了性能优化且全地域部署、支持就近和按地域接入、访问时延下降显著,接口描述更加详细、错误码描述更加全面、SDK增加接口级注释,让您更加方便快捷的使用腾讯云产品。这里针对 GO API 调用方式进行简单说明。现已支持云服务器(CVM)、云硬盘(CBS)、私有网络(VPC)、云数据库(TencentDB)等 腾讯云产品,后续会支持其他的云产品接入,敬请期待。通信协议 腾讯云 API 的所有接口均通过 HTTPS 进行通信,提供高安全性的通信通道。 3.例如云服务器的查询实例列表接口,取值为 DescribeInstances 。 RegionString-地域参数,用来标识希望操作哪个地域的数据。下面以 查看实例列表 接口为例,分步骤介绍签名的计算过程。
    来自:
  • .NET API

    腾讯云 API 全新升级3.0,该版本进行了性能优化且全地域部署、支持就近和按地域接入、访问时延下降显著,接口描述更加详细、错误码描述更加全面、SDK 增加接口级注释,让您更加方便快捷的使用腾讯云产品。通信协议 腾讯云 API 的所有接口均通过 HTTPS 进行通信,提供高安全性的通信通道。 3.例如云服务器的查询实例列表接口,取值为 DescribeInstances。 X-TC-RegionString-地域参数,用来标识希望操作哪个地域的数据。参数名称类型必选描述 ActionString是操作的接口名称。取值参考接口文档中输入参数公共参数 Action 的说明。例如云服务器的查询实例列表接口,取值为 DescribeInstances。下面以 查看实例列表 接口为例,分步骤介绍签名的计算过程。
    来自:
  • Java API

    腾讯云 API 全新升级3.0,该版本进行了性能优化且全地域部署、支持就近和按地域接入、访问时延下降显著,接口描述更加详细、错误码描述更加全面、SDK 增加接口级注释,让您更加方便快捷的使用腾讯云产品。通信协议 腾讯云 API 的所有接口均通过 HTTPS 进行通信,提供高安全性的通信通道。 3.例如云服务器的查询实例列表接口,取值为 DescribeInstances。 X-TC-RegionString-地域参数,用来标识希望操作哪个地域的数据。参数名称类型必选描述 ActionString是操作的接口名称。取值参考接口文档中输入参数公共参数 Action 的说明。例如云服务器的查询实例列表接口,取值为 DescribeInstances。下面以 查看实例列表 接口为例,分步骤介绍签名的计算过程。我们选择该接口是因为: 云服务器默认已开通,该接口很常用。该接口是只读的,不会改变现有资源的状态。
    来自:
  • Node.js API

    腾讯云 API 全新升级3.0 ,该版本进行了性能优化且全地域部署、支持就近和按地域接入、访问时延下降显著,接口描述更加详细、错误码描述更加全面、SDK 增加接口级注释,让您更加方便快捷的使用腾讯云产品通信协议 腾讯云 API 的所有接口均通过 HTTPS 进行通信,提供高安全性的通信通道。 3.参数名称类型必选描述 ActionString是操作的接口名称。取值参考接口文档中输入参数公共参数 Action 的说明。例如云服务器的查询实例列表接口,取值为 DescribeInstances。下面以 查看实例列表 接口为例,分步骤介绍签名的计算过程。请求主机:查看实例列表(DescribeInstances)的请求域名为:cvm.tencentcloudapi.com 。实际的请求域名根据接口所属模块的不同而不同,详见各接口说明。
    来自:
  • C++ API

    腾讯云 API 全新升级3.0,该版本进行了性能优化且全地域部署、支持就近和按地域接入、访问时延下降显著,接口描述更加详细、错误码描述更加全面、SDK 增加接口级注释,让您更加方便快捷的使用腾讯云产品。这里针对 C++ API 调用方式进行简单说明。现已支持云服务器(CVM)、云硬盘(CBS)、私有网络(VPC)、云数据库(TencentDB)等 腾讯云产品,后续会支持其他的云产品接入,敬请期待。通信协议 腾讯云 API 的所有接口均通过 HTTPS 进行通信,提供高安全性的通信通道。 3.例如云服务器的查询实例列表接口,取值为 DescribeInstances。 X-TC-RegionString-地域参数,用来标识希望操作哪个地域的数据。下面以 查看实例列表 接口为例,分步骤介绍签名的计算过程。我们选择该接口原因是: 云服务器默认已开通,该接口很常用。该接口是只读的,不会改变现有资源的状态。
    来自:
  • 使用 API Explorer

    腾讯云 API Explorer 工具 是一款自动化工具,目前已支持云服务器 CVM、私有网络 VPC、云硬盘 CBS 等 腾讯云产品 的 API 接口调用自动化。SecretId 及 SecretKey 可前往 API密钥管理 页面获取。 在线调用:在填写参数后,选择【发送请求】。首先进行身份验证,系统会发送您在左侧填写的参数到对应的接口。调用接口本文以 查询可用区列表 接口为例,使用 API Explorer 工具进行调用: 填写所需参数,可选择右侧功能区中的【参数说明】查看接口具体参数信息。如下图所示: 生成签名串本文以 查询可用区列表 接口为例,使用 API Explorer 工具进行签名串生成: 获取个人密钥(SecretId、SecretKey),并填入对应位置。AuthFailure.InvalidSecretId密钥非法(不是云 API 密钥类型)。 联系我们若您在使用过程中发现问题,可通过选择功能区【问题反馈】进行反馈。
    来自:
  • API 概览

    地域相关接口 接口名称接口功能 DescribeRegions查询产品支持的地域列表 DescribeZones查询产品可用区列表
    来自:
  • 购买指南

    云 API 服务本身不收取费用,仅在用户调用各产品 API 时会按照每个产品本身的服务进行收费,具体参见各产品的 费用信息。例如,用户在使用 API 接口 创建实例 RunInstances 时,创建成功后会收取该实例的费用,详情请参见 云服务器价格总览。
    来自:
  • 入门必读

    通过云 API,您只需少量代码即可快速操作云产品。为方便您快速轻松调用云 API 来管理腾讯云资源,云 API 提供了 API Explorer、腾讯云命令行工具 TCCLI、SDK、云 API 平台及 API Inspector 工具。使用工具本文以云服务器 CVM 的 查看实例列表(DescribeInstances)接口为例,引导您如何快速使用 API Explorer、TCCLI 及 SDK 工具完成接口的调用,适用于初次接触腾讯云产品的开发者用户同时云 API 提供腾讯云 API 平台以及 API Inspector 工具,方便用户查看腾讯云提供的所有 API 服务,以及控制台操作对应的 API 调用信息。SDK 简介 云 API 平台腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
    来自:
  • 使用 TCCLI

    欢迎使用腾讯云命令行工具 TCCLI,TCCLI 是管理腾讯云资源的统一工具。通过腾讯云命令行工具,您可以快速轻松的调用腾讯云 API 来管理您的腾讯云资源。: secretId:云 API 密钥 SecretId,请前往 API 密钥管理 获取(一个主账号最多可以申请两个云 API 密钥)。secretKey:云 API 密钥 SecretKey,请前往 API 密钥管理 获取。region: 云产品地域,请前往对应云产品的 API 文档 获取可用的 region。例如,在开启一台实例后,实例并不能立即进入 RUNNING 状态,则可使用结果轮询功能对实例状态轮询,直到出现 RUNNING 状态为止。如何实现接口鉴权?在 API 支持的每个产品文档目录下,可选择调用方法 > 接口鉴权,结合产品的“接口鉴权”文档进行实现。例如,可前往 CVM 接口鉴权 进行查看。
    来自:
  • 签名方法

    签名信息由安全凭证生成,安全凭证包括 SecretId 和 SecretKey;若用户还没有安全凭证,请前往 云API密钥页面 申请,否则无法调用云 API 接口。1.申请安全凭证在第一次使用云 API 之前,请前往 云 API 密钥页面 申请安全凭证。InstanceIds.0待查询的实例 IDins-09dx96dg Offset偏移量0 Limit最大允许输出20 Version接口版本号2017-03-12 2.1.请求主机:查看实例列表(DescribeInstances)的请求域名为:cvm.tencentcloudapi.com。实际的请求域名根据接口所属模块的不同而不同,详见各接口说明。签名演示在实际调用 API 3.0 时,推荐使用配套的腾讯云 SDK 3.0 ,SDK 封装了签名的过程,开发时只关注产品提供的具体接口即可。详细信息参见 SDK 中心。
    来自:
  • 返回结果

    正确返回结果以云服务器的接口查看实例状态列表 (DescribeInstancesStatus) 2017-03-12 版本为例,若调用成功,其可能的返回如下为:{ Response: { TotalCountRequestId 用于一个 API 请求的唯一标识,如果 API 出现异常,可以联系我们,并提供该 ID 来解决问题。此例中的 TotalCount 和 InstanceStatusSet 均为 DescribeInstancesStatus 接口定义的字段,由于调用请求的用户暂时还没有云服务器实例,因此 TotalCount公共错误码返回结果中如果存在 Error 字段,则表示调用 API 接口失败。 Error 中的 Code 字段表示错误码,所有业务都可能出现的错误码为公共错误码,下表列出了公共错误码。错误码错误描述 AuthFailure.InvalidSecretId密钥非法(不是云 API 密钥类型)。 AuthFailure.MFAFailureMFA 错误。
    来自:

扫码关注云+社区

领取腾讯云代金券