GetFunctionVersion - OpenSearch - Alibaba Cloud Documentation Center

Queries version information by version ID.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
opensearch:DescribeFunction	get	FunctionInstance acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}	none	none

Request syntax

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

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	array<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\"}}" } ]
CreateParameters	object	The parameter body.
Name	string	The name of the parameter.	params1
Required	string	Indicates whether the parameter is required.	true
Depends	array<object>	The dependencies of the instance.
Depends	object	The parameter body.
Condition	string	The condition.	""
Dependency	string	The dependency.	""
Description	string	The description.	""
UsageParameters	array<object>	The parameters that are used during online use of the instance.	[]
UsageParameters	object	The parameter body.
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