泛化調(diào)用
阿里云SDK不僅支持使用云產(chǎn)品SDK提供的特化調(diào)用方式調(diào)用OpenAPI,還支持使用核心SDK提供的泛化調(diào)用方式調(diào)用OpenAPI,兩種方式的不同請參見泛化調(diào)用與特化調(diào)用。本文將從獲取API信息、安裝SDK和代碼示例來為您介紹如何使用泛化調(diào)用。
獲取API信息
訪問API文檔選擇云產(chǎn)品,例如選擇云服務(wù)器ECS。
單擊云服務(wù)器名稱下面的獲取元數(shù)據(jù),在元數(shù)據(jù)中
info.style
查看云產(chǎn)品支持的OpenAPI風(fēng)格(RPC或者ROA)。說明該位置獲取的元數(shù)據(jù)中包含了云產(chǎn)品的所有API信息,如果您想要查看單個API的元數(shù)據(jù),請查看步驟2。
選擇將要調(diào)用的API,單擊右上角獲取元數(shù)據(jù)。
在元數(shù)據(jù)中,定義了API支持的網(wǎng)絡(luò)協(xié)議、請求方式、參數(shù)及參數(shù)位置等信息。如下圖所示的RunInstances元數(shù)據(jù)中:
支持的網(wǎng)絡(luò)協(xié)議有HTTP和HTTPS,建議使用HTTPS。
支持的請求方式有GET和POST,兩者請求方式調(diào)用結(jié)果無任何差異,但GET請求只支持 32 KB 以內(nèi)的請求包,所以推薦使用POST請求。
支持的參數(shù)有RegionId、ImageId等,參數(shù)位置在query,表示參數(shù)是要拼接在請求URL后面,例如https://ecs.cn-beijing.aliyuncs.com/?ImageId=aliyun_2_1903_x64_20G_alibase_20231221.vhd&InstanceChargeType=PostPaid&InstanceType=ecs.e-c1m1.large&InternetChargeType=PayByTraffic&MinAmount=1&Password=test%401234&RegionId=cn-beijing&SecurityGroupId=sg-2zec0dm6qi66XXXXXXXX&SystemDisk.Category=cloud_essd&SystemDisk.Size=40&VSwitchId=vsw-2ze3aagwn397gXXXXXXXX。
說明元數(shù)據(jù)中其他支持的內(nèi)容對簽名無影響,這里暫不詳細(xì)說明。更多元數(shù)據(jù)的信息,請參見元數(shù)據(jù)使用指南。
安裝SDK
在Terminal中執(zhí)行以下命令安裝核心SDK。
npm install @alicloud/openapi-client
示例代碼
示例:調(diào)用RPC風(fēng)格的API
以調(diào)用ECS的DescribeRegions接口為例,展示如何使用泛化調(diào)用方式。
JavaScript示例
const OpenApi = require('@alicloud/openapi-client');
const Util = require('@alicloud/tea-util');
class Client {
static async main() {
// 從環(huán)境變量中獲取阿里云訪問密鑰ID和密鑰Secret。
let config = new OpenApi.Config({
accessKeyId: process.env['ALIBABA_CLOUD_ACCESS_KEY_ID'],
accessKeySecret: process.env['ALIBABA_CLOUD_ACCESS_KEY_SECRET'],
});
config.endpoint = `ecs-cn-hangzhou.aliyuncs.com`;
let client = new OpenApi.default(config);
let params = new OpenApi.Params({
style: 'RPC', // API風(fēng)格
action: 'DescribeRegions', // API 名稱
version: '2014-05-26', // API版本號
protocol: 'HTTPS', // API協(xié)議
method: 'POST', // 請求方法
authType: 'AK',
pathname: `/`, // 接口 PATH
reqBodyType: 'json', // 接口請求體內(nèi)容格式
bodyType: 'json', // 接口響應(yīng)體內(nèi)容格式
});
let query = { 'InstanceChargeType': 'PrePaid' };
let request = new OpenApi.OpenApiRequest({
query: query,
});
let runtime = new Util.RuntimeOptions({});
let response = await client.callApi(params, request, runtime);
console.log(response.body.Regions);
}
}
exports.Client = Client;
Client.main();
TypeScript示例
import OpenApi, * as $OpenApi from '@alicloud/openapi-client';
import Util, * as $Util from '@alicloud/tea-util';
export default class Client {
static async main(): Promise<void> {
// 從環(huán)境變量中獲取阿里云訪問密鑰ID和密鑰Secret。
let config = new $OpenApi.Config({
accessKeyId: process.env['ALIBABA_CLOUD_ACCESS_KEY_ID'],
accessKeySecret: process.env['ALIBABA_CLOUD_ACCESS_KEY_SECRET'],
});
// 設(shè)置API的服務(wù)接入點(diǎn)為ecs-cn-hangzhou.aliyuncs.com。
config.endpoint = `ecs-cn-hangzhou.aliyuncs.com`;
let client = new OpenApi(config);
let params = new $OpenApi.Params({
style: 'RPC', // API風(fēng)格
action: 'DescribeRegions', // API 名稱
version: '2014-05-26', // API版本號
protocol: 'HTTPS', // API協(xié)議
method: 'POST', // 請求方法
authType: 'AK',
pathname: `/`, // 接口 PATH
reqBodyType: 'json', // 接口請求體內(nèi)容格式
bodyType: 'json', // 接口響應(yīng)體內(nèi)容格式
});
// 設(shè)置查詢參數(shù)。
let query: { [key: string]: any } = { "InstanceChargeType": "PrePaid" };
// 創(chuàng)建API請求對象。
let request = new $OpenApi.OpenApiRequest({
query: query,
});
// 設(shè)置運(yùn)行時參數(shù)
let runtime = new $Util.RuntimeOptions({});
// 返回值為 Map 類型,可從 Map 中獲得三類數(shù)據(jù):響應(yīng)體 body、響應(yīng)頭 headers、HTTP 返回的狀態(tài)碼 statusCode。
let response = await client.callApi(params, request, runtime);
console.log(response.body.Regions);
}
}
Client.main();
示例:調(diào)用RESTful(ROA)風(fēng)格的API
以調(diào)用容器服務(wù)查詢集群列表信息為例,展示如何使用泛化調(diào)用。
JavaScript示例
const OpenApi = require('@alicloud/openapi-client');
const OpenApiUtil = require('@alicloud/openapi-util');
const Util = require('@alicloud/tea-util');
const Tea = require('@alicloud/tea-typescript');
class Client {
static async main() {
// 從環(huán)境變量中獲取阿里云訪問密鑰ID和密鑰Secret。
let config = new OpenApi.Config({
accessKeyId: process.env['ALIBABA_CLOUD_ACCESS_KEY_ID'],
accessKeySecret: process.env['ALIBABA_CLOUD_ACCESS_KEY_SECRET'],
});
config.endpoint = `cs.cn-qingdao.aliyuncs.com`;
let client = new OpenApi.default(config);
let params = new OpenApi.Params({
// 接口名稱
action: 'DescribeClustersV1',
// 接口版本
version: '2015-12-15',
// 接口協(xié)議
protocol: 'HTTPS',
// 接口 HTTP 方法
method: 'GET',
authType: 'AK',
style: 'ROA',
// 接口 PATH
pathname: `/api/v1/clusters`,
// 接口請求體內(nèi)容格式
reqBodyType: 'json',
// 接口響應(yīng)體內(nèi)容格式
bodyType: 'json',
});
// query params
let queries = {};
queries['name'] = 'cluster-demo';
let request = new OpenApi.OpenApiRequest({
query: OpenApiUtil.default.query(queries),
});
// runtime options
let runtime = new Util.RuntimeOptions({});
// 返回值為 Map 類型,可從 Map 中獲得三類數(shù)據(jù):響應(yīng)體 body、響應(yīng)頭 headers、HTTP 返回的狀態(tài)碼 statusCode。
let response = await client.callApi(params, request, runtime);
console.log(response.body);
}
}
exports.Client = Client;
Client.main();
TypeScript示例
import OpenApi, * as $OpenApi from '@alicloud/openapi-client';
import OpenApiUtil from '@alicloud/openapi-util';
import Util, * as $Util from '@alicloud/tea-util';
import * as $tea from '@alicloud/tea-typescript';
export default class Client {
static async main(): Promise<void> {
let config = new $OpenApi.Config({
accessKeyId: process.env['ALIBABA_CLOUD_ACCESS_KEY_ID'],
accessKeySecret: process.env['ALIBABA_CLOUD_ACCESS_KEY_SECRET'],
});
config.endpoint = `cs.cn-qingdao.aliyuncs.com`;
let client = new OpenApi(config);
let params = new $OpenApi.Params({
// 接口名稱
action: "DescribeClustersV1",
// 接口版本
version: "2015-12-15",
// 接口協(xié)議
protocol: "HTTPS",
// 接口 HTTP 方法
method: "GET",
authType: "AK",
style: "ROA",
// 接口 PATH
pathname: `/api/v1/clusters`,
// 接口請求體內(nèi)容格式
reqBodyType: "json",
// 接口響應(yīng)體內(nèi)容格式
bodyType: "json",
});
// query params
let queries: { [key: string]: any } = { "name": "cluster-demo" };
let request = new $OpenApi.OpenApiRequest({
query: OpenApiUtil.query(queries),
});
// runtime options
let runtime = new $Util.RuntimeOptions({});
// 返回值為 Map 類型,可從 Map 中獲得三類數(shù)據(jù):響應(yīng)體 body、響應(yīng)頭 headers、HTTP 返回的狀態(tài)碼 statusCode。
let response = await client.callApi(params, request, runtime);
console.log(response.body);
}
}
Client.main();