获取一个 OpenSearch 应用的版本列表

调试

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

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

请求语法

GET /v4/openapi/app-groups/[appGroupIdentity]/apps HTTP/1.1

请求参数

名称 类型 位置 是否必选 示例值 描述
appGroupIdentity String Path my_app_group_name

应用名称

返回数据

名称 类型 示例值 描述
requestId String 77CAA411-0010-4DB9-82E2-1C384E590AFF

请求ID

result List {}

版本信息,参考:App

示例

请求示例

GET /v4/openapi/app-groups/os_function_test_v1/apps

正常返回示例

XML格式

<requestId>71AB199D-8F00-5E69-BDC6-2829553D9BBC</requestId>
<result>
    <id>123123321</id>
    <virtualCluster/>
    <description/>
    <created>1650264344</created>
    <updated>1650264631</updated>
    <type>standard</type>
    <status>ok</status>
    <progressPercent>100</progressPercent>
    <quota>
        <docSize>1</docSize>
        <computeResource>1</computeResource>
        <qps>0</qps>
        <spec>opensearch.share.common</spec>
        <usedDocSize>0</usedDocSize>
        <usedComputeResource>0</usedComputeResource>
        <usedQps>0</usedQps>
    </quota>
    <schema>
        <tables>
            <test>
                <name>test</name>
                <primaryTable>true</primaryTable>
                <fields>
                    <description>
                        <name>description</name>
                        <primaryKey>false</primaryKey>
                        <type>LITERAL</type>
                    </description>
                    <id>
                        <name>id</name>
                        <primaryKey>true</primaryKey>
                        <type>INT</type>
                    </id>
                </fields>
            </test>
        </tables>
        <indexes>
            <searchFields>
                <description>
                    <fields>description</fields>
                </description>
                <id>
                    <fields>id</fields>
                </id>
            </searchFields>
            <filterFields>id</filterFields>
            <filterFields>description</filterFields>
        </indexes>
    </schema>
    <fetchFields>id</fetchFields>
    <fetchFields>description</fetchFields>
    <firstRanks>
        <name>default</name>
        <description>sys default</description>
        <active>true</active>
        <created>1650264343</created>
        <updated>1650264343</updated>
        <type>STRUCT</type>
        <meta>
            <attribute>static_bm25()</attribute>
            <arg/>
            <weight>1</weight>
        </meta>
    </firstRanks>
    <secondRanks>
        <name>default</name>
        <description>sys default</description>
        <active>true</active>
        <created>1650264343</created>
        <updated>1650264343</updated>
        <meta/>
        <isDefault>true</isDefault>
    </secondRanks>
    <switchTime>1645520103</switchTime>
    <isCurrent>false</isCurrent>
</result>
<result>
    <id>121305419</id>
    <virtualCluster/>
    <description/>
    <created>1645519817</created>
    <updated>1645520103</updated>
    <type>standard</type>
    <status>ok</status>
    <progressPercent>100</progressPercent>
    <quota>
        <docSize>1</docSize>
        <computeResource>1</computeResource>
        <qps>0</qps>
        <spec>opensearch.share.common</spec>
        <usedDocSize>0</usedDocSize>
        <usedComputeResource>0</usedComputeResource>
        <usedQps>0</usedQps>
    </quota>
    <schema>
        <tables>
            <test>
                <name>test</name>
                <primaryTable>true</primaryTable>
                <fields>
                    <description>
                        <name>description</name>
                        <primaryKey>false</primaryKey>
                        <type>LITERAL</type>
                    </description>
                    <id>
                        <name>id</name>
                        <primaryKey>true</primaryKey>
                        <type>INT</type>
                    </id>
                </fields>
            </test>
        </tables>
        <indexes>
            <searchFields>
                <description>
                    <fields>description</fields>
                </description>
                <id>
                    <fields>id</fields>
                </id>
            </searchFields>
            <filterFields>id</filterFields>
            <filterFields>description</filterFields>
        </indexes>
    </schema>
    <fetchFields>id</fetchFields>
    <fetchFields>description</fetchFields>
    <firstRanks>
        <name>default</name>
        <description>sys default</description>
        <active>true</active>
        <created>1645519817</created>
        <updated>1645519817</updated>
        <type>STRUCT</type>
        <meta>
            <attribute>static_bm25()</attribute>
            <arg/>
            <weight>1</weight>
        </meta>
    </firstRanks>
    <secondRanks>
        <name>default</name>
        <description>sys default</description>
        <active>true</active>
        <created>1645519817</created>
        <updated>1645519817</updated>
        <meta/>
        <isDefault>true</isDefault>
    </secondRanks>
    <switchTime>1645520103</switchTime>
    <isCurrent>true</isCurrent>
</result>

JSON格式

{
    "requestId": "71AB199D-8F00-5E69-BDC6-2829553D9BBC",
    "result": [
        {
            "id": "123123321",
            "virtualCluster": "",
            "description": "",
            "created": 1650264344,
            "updated": 1650264631,
            "type": "standard",
            "status": "ok",
            "progressPercent": 100,
            "quota": {
                "docSize": 1,
                "computeResource": 1,
                "qps": 0,
                "spec": "opensearch.share.common",
                "usedDocSize": 0,
                "usedComputeResource": 0,
                "usedQps": 0
            },
            "schema": {
                "tables": {
                    "test": {
                        "name": "test",
                        "primaryTable": true,
                        "fields": {
                            "description": {
                                "name": "description",
                                "primaryKey": false,
                                "type": "LITERAL"
                            },
                            "id": {
                                "name": "id",
                                "primaryKey": true,
                                "type": "INT"
                            }
                        }
                    }
                },
                "indexes": {
                    "searchFields": {
                        "description": {
                            "fields": [
                                "description"
                            ]
                        },
                        "id": {
                            "fields": [
                                "id"
                            ]
                        }
                    },
                    "filterFields": [
                        "id",
                        "description"
                    ]
                }
            },
            "fetchFields": [
                "id",
                "description"
            ],
            "firstRanks": [
                {
                    "name": "default",
                    "description": "sys default",
                    "active": true,
                    "created": 1650264343,
                    "updated": 1650264343,
                    "type": "STRUCT",
                    "meta": [
                        {
                            "attribute": "static_bm25()",
                            "arg": "",
                            "weight": 1
                        }
                    ]
                }
            ],
            "secondRanks": [
                {
                    "name": "default",
                    "description": "sys default",
                    "active": true,
                    "created": 1650264343,
                    "updated": 1650264343,
                    "meta": "",
                    "isDefault": true
                }
            ],
            "dataSources": [],
            "summaries": [],
            "queryProcessors": [],
            "switchTime": 1645520103,
            "isCurrent": false
        },
        {
            "id": "121305419",
            "virtualCluster": "",
            "description": "",
            "created": 1645519817,
            "updated": 1645520103,
            "type": "standard",
            "status": "ok",
            "progressPercent": 100,
            "quota": {
                "docSize": 1,
                "computeResource": 1,
                "qps": 0,
                "spec": "opensearch.share.common",
                "usedDocSize": 0,
                "usedComputeResource": 0,
                "usedQps": 0
            },
            "schema": {
                "tables": {
                    "test": {
                        "name": "test",
                        "primaryTable": true,
                        "fields": {
                            "description": {
                                "name": "description",
                                "primaryKey": false,
                                "type": "LITERAL"
                            },
                            "id": {
                                "name": "id",
                                "primaryKey": true,
                                "type": "INT"
                            }
                        }
                    }
                },
                "indexes": {
                    "searchFields": {
                        "description": {
                            "fields": [
                                "description"
                            ]
                        },
                        "id": {
                            "fields": [
                                "id"
                            ]
                        }
                    },
                    "filterFields": [
                        "id",
                        "description"
                    ]
                }
            },
            "fetchFields": [
                "id",
                "description"
            ],
            "firstRanks": [
                {
                    "name": "default",
                    "description": "sys default",
                    "active": true,
                    "created": 1645519817,
                    "updated": 1645519817,
                    "type": "STRUCT",
                    "meta": [
                        {
                            "attribute": "static_bm25()",
                            "arg": "",
                            "weight": 1
                        }
                    ]
                }
            ],
            "secondRanks": [
                {
                    "name": "default",
                    "description": "sys default",
                    "active": true,
                    "created": 1645519817,
                    "updated": 1645519817,
                    "meta": "",
                    "isDefault": true
                }
            ],
            "dataSources": [],
            "summaries": [],
            "queryProcessors": [],
            "switchTime": 1645520103,
            "isCurrent": true
        }
    ]
}

错误码

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