ListFunctionInstances_智能开放搜索 OpenSearch_API文档-阿里云OpenAPI开发者门户

流控信息

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

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

opensearch:DescribeFunction	Get	FunctionInstance acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}	无	无

请求语法

GET /v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/instances HTTP/1.1

路径参数

字段名称	字段详情
appGroupIdentitystring	应用名称示例值:app_group_name参考取值来源: CreateAppGroupCredentials ListAppGroups
functionNamestring	功能名称示例值:ctr参考取值来源: CreateFunctionTask

请求参数

字段名称	字段详情
modelTypestring	模型类型示例值:tf_checkpoint
functionTypestring	功能类型示例值:"PAAS"参考取值来源: GetFunctionInstance
sourcestring	实例来源展开详情示例值:user参考取值来源: ListFunctionResources
pageNumberinteger<int32>	页码，默认值为 1 示例值:1
pageSizeinteger<int32>	每页大小，默认值为 10 示例值:10
outputstring	返回信息的丰富度展开详情示例值:normal枚举值:

请求说明

示例

GET /v4/openapi/app-groups/my-app/functions/ctr/instances?source=all&output=simple

返回参数

字段名称	字段详情
Statusstring	请求状态示例值:"OK"
HttpCodeinteger<int64>	http 状态码注意请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。示例值:200
TotalCountinteger<int64>	总条数注意请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。示例值:2
RequestIdstring	请求 id 示例值:A4D487A9-A456-5AA5-A9C6-B7BF2889CF74
Messagestring	错误信息，正常为空示例值:instance not exist.
Codestring	错误码，正常为空示例值:Instance.NotExist
Resultarray<object>	结果列表示例值:[]
Latencyinteger<int64>	api 请求耗时（单位毫秒）注意请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。示例值:123

返回说明

正常返回结果：

{
    "status": "OK",
    "requestId": "A4D487A9-A456-5AA5-A9C6-B7BF2889CF74",
    "httpCode": 200,
    "code": "",
    "message": "",
    "latency": 123,
    "totalCount": 2,
    "result": [
        {
            "versionId": 100,
            "instanceName": "instance_1",
            "functionName": "hot",
            "functionType": "PAAS",
            "modelType": "offline_inference",
            "description": "",
            "status": "available",
            "belongs": {
                "domain": "ecommerce",
                "category": "general",
                "language": "zh"
            },
            "createTime": 100010,
            "source": "user"
        },
        {
            "versionId": 100,
            "instanceName": "instance_2",
            "functionName": "hot",
            "functionType": "PAAS",
            "modelType": "offline_inference",
            "description": "",
            "status": "available",
            "belongs": {
                "domain": "ecommerce",
                "category": "general",
                "language": "zh"
            },
            "createTime": 200020,
            "source": "user",
            "default": true
        }
    ]
}

返回示例

变更历史

暂无变更历史