注意:以下文档只适用于TOP接口,请谨慎使用!

文档中心 > 聚石塔

聚石塔OpenApi使用说明

更新时间:2022/05/09 访问次数:490
  • 只支持SDK调试,不支持OpenApi Explorer上页面调试
  • 与阿里云容器服务的API不是一回事


DefaultProfile.addEndpoint("cn-hangzhou", "retailcloud", "retailcloud.aliyuncs.com")

注意这里是api的region,和聚石塔应用或者云产品的地域不一样,这里一定要设置cn-hangzhou


SDK:

Python

https://pypi.org/project/aliyun-python-sdk-retailcloud/

python源码地址:https://github.com/aliyun/aliyun-openapi-python-sdk/tree/master/aliyun-python-sdk-retailcloud


Java

<!-- https://mvnrepository.com/artifact/com.aliyun/aliyun-java-sdk-retailcloud -->
<dependency>
    <groupId>com.aliyun</groupId>
    <artifactId>aliyun-java-sdk-retailcloud</artifactId>
    <version>${retialcloud.latest.version}</version>
</dependency>


以JAVA SDK为例,在maven仓库中看sdk的最新版本:

https://mvnrepository.com/artifact/com.aliyun/aliyun-java-sdk-retailcloud


附件:API文档

20220509 更新内容(SDK version: 2.0.21)

  • OfflineAppEnvironment(下线应用环境)

?聚石塔 聚石塔OpenAPI API参考 20220509.pdf

20211021 更新内容(SDK version: 2.0.19)

  • ScaleApp(应用扩缩容)接口支持指定发布批次

?聚石塔 聚石塔OpenAPI API参考 20211021.pdf

20210729 更新内容(SDK version: 2.0.18)

  • ListAppInstance接口增加返回status字段
  • 新增应用监控相关api

?聚石塔 聚石塔OpenAPI API参考 20210729.pdf

20210223 更新内容(SDK version: 2.0.13)

  • ListAppInstance接口增加返回version字段
  • CreateEnvironment接口支持传入clusterId字段,直接关联集群

API文档如下:

?聚石塔 聚石塔OpenAPI API参考 20210223.pdf


20201230 更新内容

  • 发布接口新增支持直接指定镜像版本进行发布

API文档如下:

?聚石塔 聚石塔OpenAPI API参考 20201230.pdf



聚石塔ak sk获取

随便找一个应用-查看-设置


Java SDK示例

设置Maven依赖

<dependency>
      <groupId>com.aliyun</groupId>
      <artifactId>aliyun-java-sdk-core</artifactId>
      <version>4.5.0</version>
</dependency>

 <dependency>
      <groupId>com.aliyun</groupId>
      <artifactId>aliyun-java-sdk-retailcloud</artifactId>
      <version>2.0.12</version>
</dependency>


代码示例

//设置client
DefaultProfile profile = DefaultProfile.getProfile("cn-hangzhou", ak, sk);
DefaultProfile.addEndpoint("cn-hangzhou", "retailcloud", "retailcloud.aliyuncs.com");
IAcsClient client = new DefaultAcsClient(profile);

//构造请求,这里以查询集群详情为例
DescribeClusterDetailRequest describeClusterDetailRequest = new DescribeClusterDetailRequest();
describeClusterDetailRequest.setClusterInstanceId("xxxxxxxx");

//发起调用
DescribeClusterDetailResponse describeClusterDetailResponse = client.getAcsResponse(describeClusterDetailRequest);


Python SDK示例

安装SDK核心库依赖

如果您使用Python 2.x,执行以下命令
pip install aliyun-python-sdk-cs

如果您使用Python 3.x,执行以下命令
pip install aliyun-python-sdk-core-v3


安装聚石塔零售云库依赖

pip install aliyun-python-sdk-retailcloud


代码示例:

暂无,参考Java类型(主要是创建client 创建request并设置参数 发起请求)

聚石塔零售云库python源码地址:https://github.com/aliyun/aliyun-openapi-python-sdk/tree/master/aliyun-python-sdk-retailcloud

直接引入和使用上面的阿里云client对象和***Request对象

//例如需要调用BindGroup接口,使用class BindGroupRequest
from aliyunsdkcore.client import AcsClient;
from aliyunsdkcore.acs_exception import ClientException;
from aliyunsdkcore.acs_exception import ServerException;
from aliyunsdkretailcloud.request.v20180313.BindGroupRequest import BindGroupRequest

client = AcsClient(
    "<access-key-id>",
    "<access-key-secret>",
    "cn-hangzhou"
);
# Initialize a request and set parameters
request = BindGroupRequest()
request.setxxx(10)
# Print response
response = client.do_action_with_exception(request)
print response


Go SDK示例

安装Go SDK

使用Glide(推荐)
执行以下命令,安装阿里云Go SDK:
glide get github.com/aliyun/alibaba-cloud-sdk-go

使用govendor
执行以下命令,安装阿里云Go SDK:
go get -u github.com/aliyun/alibaba-cloud-sdk-go/sdk


代码示例:

package main

import (
    "fmt"
    "github.com/aliyun/alibaba-cloud-sdk-go/services/retailcloud"
)

func main() {
    // 创建并初始化client实例。
    // 更多方法请见 https://github.com/aliyun/alibaba-cloud-sdk-go/blob/master/docs/2-Client-CN.md。
    client,err := retailcloud.NewClientWithAccessKey("your_region", "your_access_key_id", "your_access_key_secret")
    if err != nil {
        // Handle exceptions
        fmt.Println("err")
        panic(err)
    }
    // 创建请求。
    request := retailcloud.CreateDescribeClusterDetailRequest()
    // 设置参数。
    request.FormParams = map[string]string{
        "clusterInstanceId":"xxxxx"
    };
    // 创建请求。
    response,err := client.DescribeClusterDetail(request)
    if err != nil {
        panic(err)
    }
    // 判断是否成功。
    if response.IsSuccess() {
        fmt.Printf("%s | Failed reate cluster, response is %s",response.RequestId, response.GetHttpContentString())
    } else {
        fmt.Printf("%s | Create cluster successfully",response.RequestId)
    }
}

FAQ

关于此文档暂时还没有FAQ
返回
顶部