Python SDK

下载地址

OpenSearch管控类Python SDK下载地址：https://pypi.org/project/aliyun-python-sdk-opensearch
SDK源码地址：https://github.com/aliyun/aliyun-openapi-python-sdk/tree/master/aliyun-python-sdk-opensearch

使用步骤

为了尽快使用Opensearch管控类SDK，请按照以下步骤进行。

步骤1 创建阿里云账号

具体方法请参考 阿里云账号注册流程。
为了更好地使用阿里云服务，建议尽快完成实名认证，否则部分阿里云服务将无法使用。

步骤2 获取阿里云访问秘钥

为了使用 opensearch管控类Python SDK，您必须申请阿里云的 访问秘钥。
登录阿里云 秘钥管理页面 。选择一对用于SDK的访问密钥对。如果没有，请创建一对新访问密钥，且保证它处于启用状态。有关如何创建访问密钥，参见 准备流程。

步骤3 安装阿里云Python SDK

完成以下操作安装 Python SDK：

1. 安装 SDK 核心库
   • 如果您使用 Python 2.x，执行以下命令，安装阿里云SDK核心库：

pip install aliyun-python-sdk-core

• 如果您使用 Python 3.x，执行以下命令，安装阿里云SDK核心库：

pip install aliyun-python-sdk-core-v3

1. 安装云产品 Opensearch的管控类SDK

执行以下命令安装Opensearch的管控类SDK

pip install aliyun-python-sdk-opensearch

步骤4 开始使用SDK

以创建与查看排序脚本为例，来介绍下使用Opensearch管控类SDK的主要流程：

1. 创建 Client。在创建 Client实例时，您需要获取 Region ID、AccessKey ID 和 AccessKey Secret。
2. 设置 Endpoint
3. 创建 Request 并设置参数。
4. 发起请求并处理应答或异常。

#!/bin/env python
import sys
import json
import time
import base64
from aliyunsdkcore.client import AcsClient
from aliyunsdkcore.acs_exception.exceptions import ClientException
from aliyunsdkcore.acs_exception.exceptions import ServerException
from aliyunsdkopensearch.request.v20171225 import CreateSortScriptRequest
from aliyunsdkopensearch.request.v20171225 import SaveSortScriptFileRequest
from aliyunsdkopensearch.request.v20171225 import GetSortScriptRequest
# 创建 AcsClient 实例
client = AcsClient(
   "<your-access-key-id>", 
   "<your-access-key-secret>",
   "<your-region-id>"
)
# 设置 Endpoint
# 传入 RegionId、product 名称、服务接入地址
client.add_endpoint("cn-hangzhou", "opensearch", "opensearch.cn-hangzhou.aliyuncs.com")
#创建脚本, 构造创建请求
content = {}
content["scriptName"] = "script1"
content["type"] = "cava_script"
content["scope"] = "second_rank"
contentStr = json.dumps(content)
createRequest = CreateSortScriptRequest.CreateSortScriptRequest()
createRequest.set_content_type("application/json")
createRequest.set_content(contentStr)
createRequest.set_appVersionId("123456")
createRequest.set_appGroupIdentity("appName")
try:
    response = client.do_action_with_exception(createRequest)
    print response
except ClientException as e:
    print e
except ServerException as e:
    print e
# 上传脚本内容
#code为用户脚本代码
code = 'your code'
content = {}
content["version"] = int(time.time()*1000)
content["content"] = base64.b64encode(code)
contentStr = json.dumps(content)
#构造脚本代码更新请求
saveFileRequest = SaveSortScriptFileRequest.SaveSortScriptFileRequest()
saveFileRequest.set_content_type("application/json")
saveFileRequest.set_content(contentStr)
saveFileRequest.set_appVersionId("123456")
saveFileRequest.set_appGroupIdentity("appName")
try:
    response = client.do_action_with_exception(createRequest)
    print response
except ClientException as e:
    print e
except ServerException as e:
    print e
#查看脚本状态
getRequest = GetSortScriptRequest.GetSortScriptRequest()
getRequest.set_content_type("application/json")
getRequest.set_appVersionId("123456")
getRequest.set_appGroupIdentity("appName")
getRequest.set_scriptName("script1")
try:
    response = client.do_action_with_exception(createRequest)
    print response
except ClientException as e:
    print e
except ServerException as e:
    print e