All Products
Search
Document Center

OpenSearch:GetFunctionResource

Last Updated:Aug 05, 2024

Queries an algorithm resource.

Debugging

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

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.
OperationAccess levelResource typeCondition keyAssociated operation
opensearch:DescribeFunctionget
  • FunctionResource
    acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}
    none
none

Request syntax

GET /v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/resources/{resourceName}

Request parameters

ParameterTypeRequiredDescriptionExample
appGroupIdentitystringYes

The ID of the application.

my_app_group_name
functionNamestringYes

The name of the feature.

rank
resourceNamestringYes

The name of the instance.

fg_json
outputstringNo

The output level.

Valid values:

  • simple
  • normal
  • detail
detail

Response parameters

ParameterTypeDescriptionExample
object
Statusstring

The HTTP status code. Valid values:

  • OK
  • FAIL
OK
HttpCodelong

The HTTP status code returned.

200
RequestIdstring

The request ID.

E215C843-0795-5293-AC9A-14FE0723E890
Messagestring

The error message returned.

Resource not exist.
Codestring

The error code returned. If no error occurs, this value is empty.

Resource.NotExist
Resultobject

The returned results.

CreateTimelong

The time when the resource was created. Unit: milliseconds.

1234
Dataobject

The resource data. The data structure varies with the resource type.

Contentstring

The content of the file that corresponds to a resource of the raw_file type.

abc
Generatorsarray<object>

The feature generators that correspond to resources of the feature_generator type.

object
Generatorstring

The type of the feature generator.

id
Inputobject

The input.

Featuresarray<object>

The input features.

object
Namestring

The name of the feature.

system_item_id
Typestring

The type of the feature.

item
Outputstring

The name of the output feature.

output_feature_name
Descriptionstring

The description of the resource.

""
FunctionNamestring

The name of the feature.

rank
ModifyTimelong

The time when the resource was modified. Unit: milliseconds.

1234
ReferencedInstancesarray

The algorithm instances that are referenced.

string

The name of the instance.

instance1
ResourceNamestring

The name of the resource.

fg_json
ResourceTypestring

The type of the resource.

raw_file
Latencydouble

The time consumed for the API request. Unit: milliseconds.

123

Examples

Sample success responses

JSONformat

{
  "Status": "OK",
  "HttpCode": 200,
  "RequestId": "E215C843-0795-5293-AC9A-14FE0723E890",
  "Message": "Resource not exist.",
  "Code": "Resource.NotExist",
  "Result": {
    "CreateTime": 1234,
    "Data": {
      "Content": "abc",
      "Generators": [
        {
          "Generator": "id",
          "Input": {
            "Features": [
              {
                "Name": "system_item_id",
                "Type": "item"
              }
            ]
          },
          "Output": "output_feature_name"
        }
      ]
    },
    "Description": "\"\"",
    "FunctionName": "rank",
    "ModifyTime": 1234,
    "ReferencedInstances": [
      "instance1"
    ],
    "ResourceName": "fg_json",
    "ResourceType": "raw_file"
  },
  "Latency": 123
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history