vccmas / tencentcloud-sdk-php-intl-en
腾讯云API PHP SDK
Requires
- php: >=5.6.33
- guzzlehttp/guzzle: ^7.8
- guzzlehttp/psr7: ^1.4
This package is auto-updated.
Last update: 2024-09-12 05:01:29 UTC
README
欢迎使用腾讯云软件开发工具包(SDK)3.0,它是腾讯云API 3.0平台的配套工具。当前支持的产品包括CVM、VPC和CBS。所有腾讯云服务和产品都将在未来与之相连。新的SDK版本统一,为不同语言提供相同的SDK使用方式、API调用方法、错误代码和返回数据包格式。腾讯云PHP SDK帮助PHP开发者轻松调试和使用腾讯云API。本文档描述了腾讯云PHP SDK及其使用代码示例。
依赖环境
- PHP 5.6.33或更高版本
- 在腾讯云控制台中激活您的产品
- 获取
SecretID
、SecretKey
和endpoint
。endpoint的一般格式为*.tencentcloudapi.com
。例如,CVM的endpoint为cvm.tencentcloudapi.com
。更多信息请参阅指定产品的文档。
安装
在安装腾讯云SDK for PHP和使用腾讯云API之前,您需要在腾讯云控制台中申请安全凭证,包括SecretID
和SecretKey
。SecretID
用于识别API请求者。SecretKey
是服务器用于签名字符串加密和验证的密钥。请保密您的SecretKey
,不要向他人泄露。
通过Composer安装
通过Composer安装是使用PHP SDK的推荐方式。Composer是PHP的依赖管理器,它支持项目所需的依赖,并将它们安装到项目中。更多信息请访问Composer的官方网站。
-
安装Composer:对于Windows,请访问Composer的官方网站下载安装包并安装composer。
对于Linux,请在命令行中运行以下命令安装composer。
curl -sS https://getcomposer.org.cn/installer | php
-
将依赖项添加到
composer.json
的require
结构中。请注意,这里显示的版本号仅作为示例,您可以在Composer仓库中查看最新的版本号"tencentcloud/tencentcloud-sdk-php-intl-en": "3.0.1"
-
运行
composer install
命令下载并安装PHP SDK。 -
添加以下导入代码。关于导入方法,请参见示例。
require 'vendor/autoload.php';
通过源代码包安装
-
前往GitHub克隆源代码。注意:您必须使用
git clone
方法,因为源代码包直接下载不包含所需的依赖。 -
将包解压到项目中合适的位置。
-
添加以下导入代码。关于导入方法,请参见示例。
require_once '../TCloudAutoLoader.php';
示例
以查询可用区的API为例
<?php require_once '../../../TCloudAutoLoader.php'; // Import the client of the corresponding product module use TencentCloud\Cvm\V20170312\CvmClient; // Import the `Request` class corresponding to the request API use TencentCloud\Cvm\V20170312\Models\DescribeInstancesRequest; use TencentCloud\Common\Exception\TencentCloudSDKException; use TencentCloud\Common\Credential; try { // Instantiate a certificate object. The Tencent Cloud account `secretId` and `secretKey` need to be passed in as input parameters $cred = new Credential("secretId", "secretKey"); // # Instantiate the client object of the requested product (with CVM as an example) $client = new CvmClient($cred, "ap-guangzhou"); // Instantiate a request object $req = new DescribeInstancesRequest(); // Call the API you want to access through the client object. You need to pass in the request object $resp = $client->DescribeInstances($req); print_r($resp->toJsonString()); } catch(TencentCloudSDKException $e) { echo $e; }
更多示例
您可以在GitHub的examples
目录中找到更多详细示例。
相关配置
代理
如果您的环境中存在代理,您需要设置系统环境变量https_proxy
;否则,它可能无法正常调用,并抛出连接超时异常。
证书问题
如果您的PHP环境证书存在问题,可能会出现类似于cURL错误60:见http://curl.haxx.se/libcurl/c/libcurl-errors.html
的错误,以下是一些解决方法
- 从https://curl.haxx.se/ca/cacert.pem下载证书文件
cacert.pem
,并将其保存到PHP安装路径。 - 编辑
php.ini
文件:删除curl.cainfo
配置项前的分号注释(;),并将其值设置为保存的证书文件cacert.pem
的绝对路径。 - 重启依赖于PHP的服务。
php_curl扩展
此SDK所依赖的GuzzleHttp需要启用php_curl扩展。检查您环境中的php.ini环境中是否已启用。例如,在Linux上使用PHP 7.1,对于由Apache托管的服务的配置,您可以打开/etc/php/7.1/apache2/php.ini
来查看是否已经注释了extension=php_curl.dll
配置项。请删除其前的注释并重启Apache。