5 releases (2 stable)
1.1.0 | Jul 18, 2023 |
---|---|
1.0.0 | Jun 18, 2023 |
0.3.0 | Sep 21, 2019 |
0.2.0 | Sep 1, 2019 |
0.1.0 | Aug 31, 2019 |
#2027 in Web programming
74KB
1.5K
SLoC
aliyun-openapi-core-rust-sdk
Aliyun OpenAPI POP core SDK for Rust.
Notes
You must know your AK
(accessKeyId/accessKeySecret
), and the aliyun product's endpoint
and apiVersion
.
For example, The ECS OpenAPI, the API version is 2014-05-26
.
And the endpoint list can be found at here, the center endpoint is ecs.aliyuncs.com. Add http protocol http
or https
, should be https://ecs.aliyuncs.com/
.
Install
Run the following Cargo command in your project directory:
cargo add aliyun-openapi-core-rust-sdk
Or add the following line to your Cargo.toml:
aliyun-openapi-core-rust-sdk = "1.1.0"
Usage
The RPC style client:
use std::collections::HashMap;
use std::env;
use std::error::Error;
use aliyun_openapi_core_rust_sdk::client::rpc::RPClient;
use serde::{Deserialize, Serialize};
#[derive(Serialize, Deserialize, Debug)]
#[serde(rename_all = "PascalCase")]
struct Region {
region_id: String,
region_endpoint: String,
local_name: String,
}
#[derive(Serialize, Deserialize, Debug)]
#[serde(rename_all = "PascalCase")]
struct RegionList {
request_id: String,
regions: HashMap<String, Vec<Region>>,
}
#[tokio::main]
async fn main() -> Result<(), Box<dyn Error>> {
// create rpc style api client.
let aliyun_openapi_client = RPClient::new(
env::var("ACCESS_KEY_ID")?,
env::var("ACCESS_KEY_SECRET")?,
"https://ecs.aliyuncs.com/",
);
// call `DescribeRegions` with empty queries, return `RegionList`
let response = aliyun_openapi_client
.clone()
.version("2014-05-26")
.get("DescribeRegions")
.json::<RegionList>()
.await?;
println!("DescribeRegions response: {response:#?}");
// call `DescribeInstances` with queries, return `String`
let response = aliyun_openapi_client
.version("2014-05-26")
.get("DescribeInstances")
.query([("RegionId", "cn-hangzhou")])
.text()
.await?;
println!("DescribeInstances response: {response}");
Ok(())
}
The ROA style client:
use std::collections::HashMap;
use std::env;
use std::error::Error;
use aliyun_openapi_core_rust_sdk::client::roa::ROAClient;
use serde::{Deserialize, Serialize};
use serde_json::json;
#[derive(Serialize, Deserialize, Debug)]
#[serde(rename_all = "PascalCase")]
struct TranslateData {
word_count: String,
translated: String,
}
#[derive(Serialize, Deserialize, Debug)]
#[serde(rename_all = "PascalCase")]
struct Translate {
request_id: String,
data: TranslateData,
code: String,
}
#[tokio::main]
async fn main() -> Result<(), Box<dyn Error>> {
// create roa style api client.
let aliyun_openapi_client = ROAClient::new(
env::var("ACCESS_KEY_ID")?,
env::var("ACCESS_KEY_SECRET")?,
"http://mt.aliyuncs.com",
);
// create params.
let mut params = HashMap::new();
params.insert("SourceText", "你好");
params.insert("SourceLanguage", "zh");
params.insert("TargetLanguage", "en");
params.insert("FormatType", "text");
params.insert("Scene", "general");
// call `Translate` with json params, return `Translate`
let response = aliyun_openapi_client
.version("2018-04-08")
.post("/api/translate/web/general")
.header([("Content-Type".to_string(), "application/json".to_string())])?
.body(json!(params).to_string())?
.json::<Translate>()
.await?;
println!("Translate response: {response:#?}");
Ok(())
}
Examples
Export AK info to env, then run cargo run --example <NAME>
:
export ACCESS_KEY_ID=<access_key_id>
export ACCESS_KEY_SECRET=<access_key_secret>
# ecs example
cargo run --example ecs
# rds example
cargo run --example rds
# slb example
cargo run --example slb
# vpc example
cargo run --example vpc
# log service(SLS) example
cargo run --example log_service
License
The MIT License
Dependencies
~6–22MB
~263K SLoC