使用OpenAPI示例

查看OpenAPI文档

您可以通过API概览查看支持的接口列表。本文以ListPrivateAccessTags - 批量查询内网访问标签为例，为您介绍如何使用OpenAPI集成SDK示例。

创建RAM用户并授权

身份

您可以使用阿里云账号（主账号）、RAM用户（子账号）、RAM角色调用该接口，有关各种身份的差异，请参见身份、凭证、授权。本案例中，我们使用RAM用户进行接口调用。

登录RAM访问控制，创建一个仅允许API调用的RAM用户，并记录AccessKey信息。具体操作，请参见创建RAM用户。

授权

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

2. 在选择权限区块中输入关键字CSAS进行搜索，选择AliyunCSASFullAccess策略。

   说明

   • SASE的系统权限策略如下：

     • AliyunCSASFullAccess：管理SASE的权限。

     • AliyunCSASReadOnlyAccess：只读管理SASE的权限。

   • 关于如何创建自定义权限，请参见授权信息。

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

凭证

在创建RAM用户时会默认生成一个AccessKey，可直接使用。您也可以进入到对应的RAM用户详情页面，在认证管理页签，单击创建AccessKey，创建一个新的AccessKey。具体操作，请参见创建AccessKey。

调用OpenAPI

本文以Python语言为例，为您介绍OpenAPI的调用方法。

准备Python环境

1. 下载并安装Python。

   Python 3的下载地址，请参见Python 3。

2. 查看Python版本。

   • Linux和macOS系统

     打开终端，输入python --version。

   • Windows系统

     • 在Python的安装路径下，双击python.exe。

     • 打开命令提示符页面。

       通过键盘快捷键Win+R打开运行对话框，输入命令python，单击确定。

配置环境变量

为避免将AccessKey硬编码到业务代码中带来的安全风险，本示例采用配置环境变量的方法管理AccessKey。

• 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_ID和ALIBABA_CLOUD_ACCESS_KEY_SECRET，并写入已准备好的AccessKey ID和AccessKey Secret。然后重启Windows系统。

安装依赖

pip install alibabacloud_credentials
pip install alibabacloud_csas20230120==1.0.1
pip install alibabacloud_tea_console

下载示例代码

1. 在OpenAPI门户，访问ListPrivateAccessTags - 批量查询内网访问标签接口的调试地址。

2. 在参数配置页签，输入必选参数CurrentPage和PageSize的值，然后单击发起调用。

3. 在SDK示例页签，单击Python页签，获取Python语言的SDK示例。

4. 单击下载完整工程，下载示例代码包。

5. 在本地解压示例代码包，并进入alibabacloud_sample目录。

运行代码

执行以下命令：

python sample.py

得到如下输出结果：

{
	"headers": {
		"date": "Fri, 11 Aug 2023 03:36:37 GMT",
		"content-type": "application/json;charset=utf-8",
		"content-length": "372",
		"connection": "keep-alive",
		"keep-alive": "timeout=25",
		"access-control-allow-origin": "*",
		"access-control-expose-headers": "*",
		"x-acs-request-id": "E556521A-CC49-506D-8FB3-753CA5AE****",
		"x-acs-trace-id": "92cce71cf7f21e142c86d7fbb46d****",
		"etag": "3Eqai375bf2r78EqTr+R****"
	},
	"statusCode": 200,
	"body": {
		"RequestId": "E556521A-CC49-506D-8FB3-753CA5AED661",
		"Tags": [{
			"ApplicationIds": ["pa-application-58a9942ea689****", "pa-application-91f960671233****", "pa-application-c2ed1730f5f9****", "pa-application-e3f8d2c00703****"],
			"CreateTime": "2021-01-12 17:53:54",
			"Description": "",
			"Name": "业务系统",
			"PolicyIds": [],
			"TagId": "tag-3d3c384d002d****",
			"TagType": "Default"
		}],
		"TotalNum": 18
	}
}