GetApp - 获取应用详情

调用GetApp接口,获取Elasticsearch Serverless应用的详情信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
es-serverless:GetApp
  • 全部资源
    *

请求语法

GET /openapi/es-serverless/instances/{appName}

请求参数

名称类型必填描述示例值
appNamestring

应用名称。调用 ListApps 获取应用名称。

test
detailedboolean

是否获取详细信息。取值如下:

  • false(默认):不获取
  • true:获取
false

返回参数

名称类型描述示例值
object

返回参数。

resultobject

返回结果。

appNamestring

应用名称。

es-severless-test-app
ownerIdstring

应用所属的阿里云主账号 UID。

*******7595
regionIdstring

应用所在地域。

cn-hangzhou
statusstring

应用状态:

  • ACTIVE:正常
  • INIT:创建中
  • INACTIVE:冻结
ACTIVE
createTimestring

应用创建时间。

2022-08-15T11:20:52.370Z
modifiedTimestring

更新时间。

2022-08-15T11:21:50.000Z
descriptionstring

应用备注。

这是一个demo应用
appIdstring

应用 ID。

test-app-abc
versionstring

产品版本。

7.10
instanceIdstring

实例 ID。

es-serverless-***17id**
networkarray<object>

公网信息。

object

公网信息具体结构。

typestring

IP 白名单的类型

  • PUBLIC_ES:Elasticsearch 公网访问白名单
  • PUBLIC_KIBANA:Kibana 公网访问白名单
PUBLIC_ES
enabledboolean

是否开启公网访问。

true
domainstring

域名信息。

test-123.public.cn-hangzhou.es-serverless.aliyuncs.com
portinteger

端口号。

9200
whiteIpGrouparray<object>

白名单列表

object

白名单具体结构

groupNamestring

白名单组的组名。

test
ipsarray

白名单组中的 IP 地址列表。

string

具体 IP 或 IP 段。

127.0.0.1
privateNetworkarray<object>

私网信息。

object

私网信息具体结构。

typestring

IP 白名单的类型

  • PRIVATE_KIBANA:Kibana 私网访问白名单
  • PRIVATE_ES:Elasticsearch 私网访问白名单
PRIVATE_ES
enabledboolean

是否开启私网访问。

true
domainstring

域名信息。

test-123.private.cn-hangzhou.es-serverless.aliyuncs.com
portinteger

端口号

9200
vpcIdstring

VPC ID。

vpc-bp16ul4pwsg1mjni***
pvlEndpointIdstring

终端节点信息。

ep-aaaddd**
whiteIpGrouparray<object>

白名单列表

object

白名单具体结构

groupNamestring

白名单组的组名。

test
ipsarray

白名单组中的 IP 地址列表。

string

具体 IP 或 IP 段。

127.0.0.1
requestIdstring

请求 ID。

2C5DAA30-****-5181-9B87-9D6181016197

示例

正常返回示例

JSON格式

{
  "result": {
    "appName": "es-severless-test-app",
    "ownerId": "*******7595",
    "regionId": "cn-hangzhou",
    "status": "ACTIVE",
    "createTime": "2022-08-15T11:20:52.370Z",
    "modifiedTime": "2022-08-15T11:21:50.000Z",
    "description": "这是一个demo应用",
    "appId": "test-app-abc",
    "version": "7.10",
    "instanceId": "es-serverless-***17id**",
    "network": [
      {
        "type": "PUBLIC_ES",
        "enabled": true,
        "domain": "test-123.public.cn-hangzhou.es-serverless.aliyuncs.com",
        "port": 9200,
        "whiteIpGroup": [
          {
            "groupName": "test",
            "ips": [
              "127.0.0.1"
            ]
          }
        ]
      }
    ],
    "privateNetwork": [
      {
        "type": "PRIVATE_ES",
        "enabled": true,
        "domain": "test-123.private.cn-hangzhou.es-serverless.aliyuncs.com",
        "port": 9200,
        "vpcId": "vpc-bp16ul4pwsg1mjni***",
        "pvlEndpointId": "ep-aaaddd**",
        "whiteIpGroup": [
          {
            "groupName": "test",
            "ips": [
              "127.0.0.1"
            ]
          }
        ]
      }
    ],
    "appType": ""
  },
  "requestId": "2C5DAA30-****-5181-9B87-9D6181016197"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-05-22OpenAPI 返回结构发生变更查看变更详情