Updated on 2026-10-27 GMT+08:00

Querying Resources

Function

This API is used to query resources.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

POST /v2/{project_id}/{resource_type}/resource-instances/{action}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Parameter description:

Project ID. For details, see Obtaining a Project ID.

Constraints:

None

Value range:

32 characters, including letters and digits.

Default value:

None

resource_type

Yes

String

Parameter description:

Resource type.

Constraints:

None

Value range:

Only functions is allowed.

Default Value:

None

action

Yes

String

Parameter description:

Query method.

Constraints:

None

Value range:

|- filter: queries specific resources based on query criteria.

count: count

Default Value:

None

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

String

Definition

Number of records displayed on each page.

Constraints

N/A

Range

N/A

Default Value

N/A

offset

No

String

Definition

Query offset.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Parameter description:

User token.

The token can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token.

Constraints:

None

Value range:

None

Default value:

None

Content-Type

Yes

String

Parameter description:

Specifies the type (or format) of the message body.

Constraints:

None

Value range:

Only application/json is supported.

Default value:

application/json

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

without_any_tag

No

Boolean

Parameter description:

Whether to use tag-based filtering.

Constraints

None

Range:

None

Default Value

None

action

No

String

Parameter description:

Query method.

Constraints

None

Range

|- filter: queries specific resources based on query criteria.

count: count

Default Value

None

matches

No

Array of KvItem objects

Parameter description:

Query a key-value pair.

Constraints

None

Range:

None

Default Value

None

sys_tags

No

Array of TagItem objects

Parameter description:

System tags

Constraints

None

Range:

None

Default Value

None

Table 5 KvItem

Parameter

Mandatory

Type

Description

key

No

String

Parameter description:

Key.

Constraints

It can contain uppercase and lowercase letters, digits, hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF).

Range

1 to 36 characters.

Default Value

None

value

No

String

Parameter description:

Specifies the value.

Constraints

It can contain uppercase and lowercase letters, digits, hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF).

Range

1 to 36 characters.

Default Value

None

Table 6 TagItem

Parameter

Mandatory

Type

Description

key

No

String

Definition

Key.

Range

1 to 36 characters.

Character set: A-Z, a-z, 0-9, hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF)

values

No

Array of strings

Definition

Specifies the value.

Range

0 to 36 characters.

Character set: A-Z, a-z, 0-9, periods (.), hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF)

Response Parameters

Status code: 200

Table 7 Response body parameters

Parameter

Type

Description

resources

Array of ListEnterpriseResourceResult objects

Enterprise projects.

total_count

Long

Number of resources.

Table 8 ListEnterpriseResourceResult

Parameter

Type

Description

resource_id

String

Unique ID of a function resource

resource_detail

ListEnterpriseResourceDetail object

tags

Array of KvItem objects

Tag list.

sys_tags

Array of KvItem objects

System tags.

resource_name

String

Resource name.

Table 9 ListEnterpriseResourceDetail

Parameter

Type

Description

detailId

String

Function URN.

Table 10 KvItem

Parameter

Type

Description

key

String

Parameter description:

Key.

Range

1 to 36 characters.

value

String

Parameter description:

Specifies the value.

Range

1 to 36 characters.

Status code: 400

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 401

Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 403

Table 13 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 404

Table 14 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 15 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

Query resources.

POST https://{Endpoint}/v2/{project_id}/{resource_type}/resource-instances/{action}

{
  "without_any_tag" : true,
  "matches" : [ {
    "key" : "resource_name",
    "value" : "test_function"
  } ]
}

Example Responses

Status code: 200

{
  "resources" : [ {
    "resource_id" : "34e4516e-e324-412b-914e-c4e568c7d813",
    "resource_detail" : {
      "detailId" : "urn:fss:{region-id}:xxxx:function:default:test_xxx:latest"
    },
    "tags" : [ ],
    "sys_tags" : [ {
      "key" : "_sys_enterprise_project_id",
      "value" : "df5edab8-c458-4a4c-b87b-a4d3b0a757ce"
    } ],
    "resource_name" : "test_v2_1"
  } ],
  "total_count" : 1
}

SDK Sample Code

The SDK sample code is as follows.

Java

Query resources.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.functiongraph.v2.region.FunctionGraphRegion;
import com.huaweicloud.sdk.functiongraph.v2.*;
import com.huaweicloud.sdk.functiongraph.v2.model.*;

import java.util.List;
import java.util.ArrayList;

public class ShowResInstanceInfoSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        FunctionGraphClient client = FunctionGraphClient.newBuilder()
                .withCredential(auth)
                .withRegion(FunctionGraphRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowResInstanceInfoRequest request = new ShowResInstanceInfoRequest();
        request.withResourceType("{resource_type}");
        request.withAction("{action}");
        ListEnterpriseResourceRequestBody body = new ListEnterpriseResourceRequestBody();
        List<KvItem> listbodyMatches = new ArrayList<>();
        listbodyMatches.add(
            new KvItem()
                .withKey("resource_name")
                .withValue("test_function")
        );
        body.withMatches(listbodyMatches);
        body.withWithoutAnyTag(true);
        request.withBody(body);
        try {
            ShowResInstanceInfoResponse response = client.showResInstanceInfo(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Python

Query resources.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkfunctiongraph.v2.region.functiongraph_region import FunctionGraphRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkfunctiongraph.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = FunctionGraphClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(FunctionGraphRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ShowResInstanceInfoRequest()
        request.resource_type = "{resource_type}"
        request.action = "{action}"
        listMatchesbody = [
            KvItem(
                key="resource_name",
                value="test_function"
            )
        ]
        request.body = ListEnterpriseResourceRequestBody(
            matches=listMatchesbody,
            without_any_tag=True
        )
        response = client.show_res_instance_info(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

Query resources.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    functiongraph "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/functiongraph/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/functiongraph/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/functiongraph/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := functiongraph.FunctionGraphClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := functiongraph.NewFunctionGraphClient(hcClient)

    request := &model.ShowResInstanceInfoRequest{}
	request.ResourceType = "{resource_type}"
	request.Action = "{action}"
	keyMatches:= "resource_name"
	valueMatches:= "test_function"
	var listMatchesbody = []model.KvItem{
        {
            Key: &keyMatches,
            Value: &valueMatches,
        },
    }
	withoutAnyTagListEnterpriseResourceRequestBody:= true
	request.Body = &model.ListEnterpriseResourceRequestBody{
		Matches: &listMatchesbody,
		WithoutAnyTag: &withoutAnyTagListEnterpriseResourceRequestBody,
	}
	response, err := client.ShowResInstanceInfo(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

More

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

ok

400

Bad request.

401

Unauthorized.

403

Forbidden.

404

Not found.

500

Internal server error.

Error Codes

See Error Codes.