DescribeAppGroup - 开放搜索

调试

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

请求头

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

请求语法

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

请求参数


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

返回数据


名称	类型	示例值	描述
requestId	String	0A6EB64B-B4C8-CF02-810F-E660812972FF	请求ID
result	Struct		应用信息
chargeType	String	POSTPAY	付费类型 POSTPAY 后付费（按量付费） PREPAY 预付费（包年包月
chargingWay	Integer	1	计费类型 1：计算资源 2：qps
commodityCode	String	opensearch	商品CODE
created	Integer	1575442875	创建时间戳
currentVersion	String	110116134	当前在线版本
description	String	-	应用描述
expireOn	String	-	过期时间
firstRankAlgoDeploymentId	Integer	0	粗排部署ID
hasPendingQuotaReviewTask	Integer	0	是否配额审批中 0：正常 1：配额审批中
id	String	110116134	应用ID
instanceId	String	-	实例ID
lockMode	String	Unlock	锁定状态 Unlock 正常 LockByExpiration 实例过期自动锁定 ManualLock 手动触发锁定
lockedByExpiration	Integer	0	实例过期自动锁定
name	String	os_function_test_v1	应用名称
pendingSecondRankAlgoDeploymentId	Integer	0	部署中的精排部署ID
processingOrderId	String	-	未结束订单号
produced	Integer	1	是否生产完成 0：生产中 1：生产完成
projectId	String	-	abtest project 名称
quota	Struct		应用配额信息
computeResource	Integer	20	计算资源 (单位:LCU)
docSize	Integer	1	存储容量 (单位:GB)
spec	String	opensearch.share.common	规格 opensearch.share.junior 入门型 opensearch.share.common 共享通用型 opensearch.share.compute 共享计算型 opensearch.share.storage 共享存储型 opensearch.private.common 独享通用型 opensearch.private.compute 独享计算型 opensearch.private.storage 独享存储型
secondRankAlgoDeploymentId	Integer	0	精排部署ID
status	String	normal	应用状态 producing 生产中 review_pending 生产审批中 config_pending 待配置 normal 正常 frozen 已冻结
switchedTime	Integer	0	在线版本切换时间戳
type	String	enhanced	应用类型 standard 标准版 advance 老高级版（新应用不支持此类型） enhanced 新高级版
updated	Integer	1578916076	更新时间戳

示例

请求示例

GET /v4/openapi/app-groups/110116134

正常返回示例

XML格式

<requestId>0A6EB64B-B4C8-CF02-810F-E660812972FF</requestId>
<result>
    <id>110116134</id>
    <name>os_function_test_v1</name>
    <currentVersion>110116134</currentVersion>
    <switchedTime>0</switchedTime>
    <quota>
        <docSize>1</docSize>
        <computeResource>20</computeResource>
        <spec>opensearch.share.common</spec>
    </quota>
    <chargingWay>1</chargingWay>
    <type>enhanced</type>
    <versions>100298792</versions>
    <projectId/>
    <chargeType>POSTPAY</chargeType>
    <expireOn/>
    <instanceId/>
    <commodityCode>opensearch</commodityCode>
    <processingOrderId/>
    <firstRankAlgoDeploymentId>0</firstRankAlgoDeploymentId>
    <secondRankAlgoDeploymentId>0</secondRankAlgoDeploymentId>
    <pendingSecondRankAlgoDeploymentId>0</pendingSecondRankAlgoDeploymentId>
    <description/>
    <produced>1</produced>
    <lockedByExpiration>0</lockedByExpiration>
    <hasPendingQuotaReviewTask>0</hasPendingQuotaReviewTask>
    <created>1575442875</created>
    <updated>1578916076</updated>
    <status>normal</status>
    <lockMode>Unlock</lockMode>
</result>

JSON格式

{
    "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
    "result": {
        "id": 110116134,
        "name": "os_function_test_v1",
        "currentVersion": 110116134,
        "switchedTime": 0,
        "quota": {
            "docSize": 1,
            "computeResource": 20,
            "spec": "opensearch.share.common"
        },
        "chargingWay": 1,
        "type": "enhanced",
        "versions": 100298792,
        "projectId": "",
        "chargeType": "POSTPAY",
        "expireOn": "",
        "instanceId": "",
        "commodityCode": "opensearch",
        "processingOrderId": "",
        "firstRankAlgoDeploymentId": 0,
        "secondRankAlgoDeploymentId": 0,
        "pendingSecondRankAlgoDeploymentId": 0,
        "description": "",
        "produced": 1,
        "lockedByExpiration": 0,
        "hasPendingQuotaReviewTask": 0,
        "created": 1575442875,
        "updated": 1578916076,
        "status": "normal",
        "lockMode": "Unlock"
    }
}

错误码

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