Retrieve Function Version Details with GetFunctionVersion - OpenSearch

Queries the information about a function version.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

opensearch:DescribeFunction

get

*FunctionInstance

acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}

None

Request syntax

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

Path Parameters

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

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Sample request

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

Response elements

Element	Type	Description	Example
	object	The response body.	{}
Status	string	The request status.	OK
HttpCode	integer	The HTTP status code.	200
RequestId	string	The request ID.	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 version configuration.	{ "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": "dependency", "condition": "condition", "description": "" } ], "usageParameters": [] }
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\"}}" } ]
	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.	[ { "dependency": "dependency", "condition": "condition", "description": "" } ]
	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.	[]
	object	The parameter body.	{}
Name	string	The name of the parameter.	""
Required	string	Indicates whether the parameter is required.	""
VersionId	integer	The ID of the version.	101
VersionName	string	The name of the version.	v1
Latency	integer	The request latency.	123

Sample success response

{
    "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

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.