Querying Resources
Function
This API is used to query resources.
URI
POST /v2/{project_id}/{resource_type}/resource-instances/{action}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details, see Obtaining a Project ID. |
resource_type |
Yes |
String |
Resource type. Enter functions here. |
action |
Yes |
String |
Filter or count. Enumeration values:
|
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. |
Content-Type |
Yes |
String |
Message body type (format). |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
without_any_tag |
No |
Boolean |
Whether to use tag-based filtering. |
limit |
No |
String |
Number of records displayed on each page. |
offset |
No |
String |
Query offset. |
action |
No |
String |
Query an action. Enumeration values:
|
matches |
No |
Array of KvItem objects |
Query a key-value pair. |
sys_tags |
No |
Array of TagItem objects |
Query system tags. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
resources |
Array of ListEnterpriseResourceResult objects |
Enterprise projects. |
total_count |
Long |
Number of resources. |
Parameter |
Type |
Description |
---|---|---|
resource_id |
String |
Resource ID. |
resource_detail |
ListEnterpriseResourceDetail object |
|
tags |
Array of KvItem objects |
Tag list. |
sys_tags |
Array of KvItem objects |
System tags. |
resource_name |
String |
Resource name. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 500
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, "limit" : 5, "matches" : [ { "key" : "resource_name", "value" : "test_function" } ] }
Example Responses
Status code: 200
ok
-
Example 1
{ "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" } ] }
-
Example 2
1
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.