GetFunctionVersion - OpenSearch - Alibaba Cloud Documentation Center

Queries version information by version ID.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

GET /v4/openapi/functions/{functionName}/versions/{versionId}

Request parameters

Parameter	Type	Required	Description	Example
functionName	string	Yes	The name of the feature.	ctr
versionId	integer	Yes	The ID of the version.	100

Sample requests

GET /v4/openapi/functions/ctr/version/101

Response parameters

Parameter	Type	Description	Example
	object	The response body.
Status	string	The status of the request.	OK
HttpCode	long	The HTTP status code.	200
RequestId	string	The ID of the request.	1638157479281
Message	string	The error message.	version not exist.
Code	string	The error code.	Version.NotExist
Result	object	The result body.
FunctionName	string	The name of the feature.	ctr
FunctionType	string	The type of the feature. Valid values: PAAS SAAS	PAAS
ModelType	string	The type of the model.	tf_checkpoint
VersionConfig	object	The configuration information.
CreateParameters	object []	The parameters that are used to create the instance.	[ { "name": "params1", "required": "true", "formItemProps": "{\"required\": true, \"pattern?\": \"/^[a-zA-Z][a-zA-Z0-9_]{0,29}$/\"}", "componentProps": "{\"component\": \"Input\", \"attributes\": {\"defaultValue\": \"value1\"}}" } ]
Name	string	The name of the parameter.	params1
Required	string	Indicates whether the parameter is required.	true
Depends	object []	The dependencies of the instance.
Condition	string	The condition.	""
Dependency	string	The dependency.	""
Description	string	The description.	""
UsageParameters	object []	The parameters that are used during online use of the instance.	[]
Name	string	The name of the instance.	""
Required	string	Indicates whether the parameter is required.	""
VersionId	long	The ID of the version.	101
VersionName	string	The name of the version.	v1
Latency	long	The maximum duration for which a task can be executed.	123

Sample success responses

{
    "status": "OK",
    "requestId": "",
    "httpCode": 200,
    "code": "",
    "message": "",
    "latency": 123,
    "result": {
        "versionName": "v1",
        "versionId": 101,
        "functionName": "ctr",
        "modelType": "tf_checkpoint",
        "functionType": "PAAS",
        "versionConfig": {
            "createParameters": [
                {
                    "name": "params1",
                    "required": "true",
                    "formItemProps": "{\"required\": true, \"pattern?\": \"/^[a-zA-Z][a-zA-Z0-9_]{0,29}$/\"}",
                    "componentProps": "{\"component\": \"Input\", \"attributes\": {\"defaultValue\": \"value1\"}}"
                }
            ],
            "depends": [
                {
                    "dependency": "the dependency",
                    "condition": "the condition",
                    "description": ""
                }
            ],
            "usageParameters": []
        }
    }
}

Examples

Sample success responses

JSONformat

{
  "Status": "OK",
  "HttpCode": 200,
  "RequestId": "1638157479281",
  "Message": "version not exist.",
  "Code": "Version.NotExist",
  "Result": {
    "FunctionName": "ctr",
    "FunctionType": "PAAS",
    "ModelType": "tf_checkpoint",
    "VersionConfig": {
      "CreateParameters": [
        {
          "Name": "params1",
          "Required": "true"
        }
      ],
      "Depends": [
        {
          "Condition": "\"\"",
          "Dependency": "\"\"",
          "Description": "\"\""
        }
      ],
      "UsageParameters": [
        {
          "Name": "\"\"",
          "Required": "\"\""
        }
      ]
    },
    "VersionId": 101,
    "VersionName": "v1"
  },
  "Latency": 123
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history