文档

使用OpenAPI示例

更新时间:

本文介绍如何使用阿里云Python语言SDK开发包,调用云数据库HBase版的DescribeInstances接口(查询实例列表及其基本信息)。

查看OpenAPI文档

在调用OpenAPI前,建议您先阅读对应接口文档,了解、学习调用该接口所需要的参数及权限等,更多信息请参见API概览

创建RAM用户并完成授权

如您已创建RAM用户且已完成授权,可跳过此步骤。

  1. 创建RAM用户:

    1. 访问RAM用户列表,单击创建用户

    2. 设置登录名称hbase-openapi-operator,选择访问方式OpenAPI 调用访问

    3. 单击确定,创建RAM用户并保存AccessKey ID与AccessKey Secret信息。

  2. 完成授权:

    1. 访问RAM用户列表,单击目标RAM用户操作列的添加权限

    2. 在文本框中搜索AliyunHBase,选择AliyunHBaseReadOnlyAccess策略。

      说明

      AliyunHBaseReadOnlyAccess策略拥有查询HBase实例的操作权限,您也可以按需选择AliyunHBaseFullAccess权限(具有查询、修改HBase实例的完全控制权限)或进行自定义策略,更多信息请参见自定义RAM授权策略

    3. 单击确定,完成授权操作。

调用OpenAPI

本文介绍阿里云Python语言SDK方式调用OpenAPI,其他语言SDK的用法也类似,更多信息请参见云数据库HBase版SDK

准备Python环境

下载并安装Python 3。如您已安装Python,查看Python版本的命令示例:python --version

配置环境变量

配置环境变量ALIBABA_CLOUD_ACCESS_KEY_IDALIBABA_CLOUD_ACCESS_KEY_SECRET

  • Linux和macOS系统:将以下命令中的<access_key_id><access_key_secret>替换为您自己的AccessKey ID和AccessKey Secret,然后在终端设备中逐条运行。

    export ALIBABA_CLOUD_ACCESS_KEY_ID=<access_key_id>
    export ALIBABA_CLOUD_ACCESS_KEY_SECRET=<access_key_secret>
  • Windows系统:新建环境变量文件,添加环境变量ALIBABA_CLOUD_ACCESS_KEY_IDALIBABA_CLOUD_ACCESS_KEY_SECRET,并写入已准备好的AccessKey ID和AccessKey Secret。然后重启Windows系统。

安装依赖

在终端设备中,逐条运行如下命令,安装环境依赖。

pip install alibabacloud_credentials
pip install alibabacloud_hbase20190101
pip install alibabacloud_tea_console

下载示例代码

  1. 访问DescribeInstances,进入该接口在OpenAPI门户的调试地址。

  2. 在左侧的参数配置页签,填写需要的参数信息,本示例需在RegionId参数中输入cn-hangzhou

  3. 在右侧的SDK示例页签,选择Python语言,单击下载完整工程按钮,下载示例代码包。

  4. 本地解压并进入alibabacloud_sample目录。

运行代码

执行以下命令。

python sample.py

返回示例如下。

[
    LOG
] {
    "headers": {
        "date": "Mon, 24 Jul 2023 09:56:30 GMT",
        "content-type": "application/json;charset=utf-8",
        "content-length": "943",
        "connection": "keep-alive",
        "keep-alive": "timeout=25",
        "access-control-allow-origin": "*",
        "access-control-expose-headers": "*",
        "x-acs-request-id": "C20BAA8E-C543-58F1-A611-9C812336****",
        "x-acs-trace-id": "63ca81587ddddeb0d47443462b3d****",
        "etag": "919xrdSHGE5LzH4To3ra****"
    },
    "body": {
        "Instances":{
            "Instance": [
                {
                    "BackupStatus": "open",
                    "ClusterId": "ld-bp1st3v9780tk****",
                    "ClusterName": "Test",
                    "ClusterType": "cluster",
                    "ColdStorageStatus": "open",
                    "CoreDiskCount": 4,
                    "CoreDiskSize": 100,
                    "CoreDiskType": "cloud_ssd",
                    "CoreInstanceType": "hbase.sn2.large",
                    "CoreNodeCount": 4,
                    "CreatedTime": "2023-07-24T17:44:54",
                    "CreatedTimeUTC": "2023-07-24T09:44:54Z",
                    "Engine": "hbaseue",
                    "InstanceId": "ld-bp1st3v9780tk****",
                    "InstanceName": "Test",
                    "IsDeletionProtection": false,
                    "IsHa": true,
                    "MajorVersion": "2.0",
                    "MasterDiskSize": 0,
                    "MasterDiskType": "",
                    "MasterInstanceType": "hbase.sn1.large",
                    "MasterNodeCount": 2,
                    "ModuleId": 0,
                    "NetworkType": "VPC",
                    "PayType": "Postpaid",
                    "RegionId": "cn-hangzhou",
                    "ResourceGroupId": "rg-acfmz7u4zzr****",
                    "Status": "ACTIVATION",
                    "Tags": {
                        "Tag": []
                },
                "VpcId": "vpc-bp16crlc5o2dmwi8p****",
                "VswitchId": "vsw-bp1sueafuqh4ly8ae****",
                "ZoneId": "cn-hangzhou-f"
                }
            ]
        },
        "PageNumber": 1,
        "PageSize": 10,
        "RequestId": "C20BAA8E-C543-58F1-A611-9C812336****",
        "TotalCount": 1
    }
}
  • 本页导读 (1)
文档反馈