GetInstance_开放搜索-问天引擎_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

方法

GET

URI

/openapi/ha3/instances/{instanceId}

流控信息

当前云产品API请求速率暂未透出。

授权信息

当前云产品暂无权限信息透出。

请求语法

GET /openapi/ha3/instances/{instanceId} HTTP/1.1

路径参数

字段名称字段详情
instanceIdstring

实例 ID。

示例值:ha-cn-pl32rf0****参考取值来源:
    ListInstances
    UpdateInstance
    CreateInstance
    CloneSqlInstance
    ExecuteSqlInstance

请求说明

请求示例

GET /openapi/ha3/instances/ha3-cn-xxxxxx

返回参数

字段名称字段详情
resultobject

返回结果

requestIdstring

请求 ID

示例值:E7B7D598-B080-5C8E-AA35-D43EC0D5F886

返回说明

返回示例

正常返回示例

{
    "result":
    {
        "inDebt": false,
        "lockMode": "Unlock",
        "trFreeUrl": "",
        "chargeType": "POSTPAY",
        "edition": "vector",
        "description": "ha-cn-vkl3rgrfc01",
        "updateTime": "2024-05-30 10:52:00.0",
        "userName": "admin",
        "version": "vector_service_1.2.2",
        "spec":
        {
            "qrsResource":
            {
                "category": "local_ssd",
                "cpu": 2,
                "mem": 8,
                "disk": 100,
                "nodeCount": 0
            },
            "searchResource":
            {
                "category": "local_ssd",
                "cpu": 2,
                "mem": 16,
                "disk": 100,
                "nodeCount": 1
            }
        },
        "network":
        {
            "vSwitchId": "vsw-bp16qw5mbrzx66lv4n0m2",
            "vpcId": "vpc-bp1956duqqe2lm2lvqjf1",
            "endpoint": "ha-cn-vkl3rgrfc01.ha.aliyuncs.com"
        },
        "tags":
        [
            {
                "value": "rg-acfmv2hk2jpsxia",
                "key": "acs:rm:rgId"
            }
        ],
        "noQrs": true,
        "instanceId": "ha-cn-vkl3rgrfc01",
        "createTime": "2024-05-30 10:50:33.0",
        "commodityCode": "opensearch_ha3post_public_cn",
        "resourceGroupId": "rg-acfmv2hk2jpsxia",
        "newMode": true,
        "status": "READY"
    },
    "requestId": "B916FBC8-DF19-1D12-A72F-61AFFDD871AD"
}

异常返回示例

{
  "requestId": "BD1EA715-DF6F-06C2-004C-C1FA0D3A9820",
  "httpCode": 404,
  "code": "App.NotFound",
  "message": "App not found"
}

返回示例

变更历史

变更时间变更内容概要操作
2025-04-22
变更返回参数
2025-01-03
变更返回参数
2024-07-17
删除返回参数
2022-01-12
新增OpenAPI,根据实例ID查看实例详情

相关示例