查询资源实例
功能介绍
查询资源实例。
调用方法
请参见如何调用API。
URI
POST /v2/{project_id}/{resource_type}/resource-instances/{action}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
租户项目 ID,获取方式请参见获取项目ID。 |
resource_type |
是 |
String |
资源类型,此处请填写functions |
action |
是 |
String |
过滤/计数 枚举值:
|
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
Content-Type |
是 |
String |
消息体的类型(格式) |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
resources |
Array of ListEnterpriseResourceResult objects |
企业项目列表 |
total_count |
Long |
资源数 |
参数 |
参数类型 |
描述 |
---|---|---|
resource_id |
String |
资源ID |
resource_detail |
ListEnterpriseResourceDetail object |
|
tags |
Array of KvItem objects |
标签列表 |
sys_tags |
Array of KvItem objects |
系统标签列表 |
resource_name |
String |
资源名称 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
状态码: 403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
状态码: 404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
请求示例
查询资源实例。
POST https://{Endpoint}/v2/{project_id}/{resource_type}/resource-instances/{action} { "without_any_tag" : true, "limit" : 5, "matches" : [ { "key" : "resource_name", "value" : "test_function" } ] }
响应示例
状态码: 200
ok
-
示例 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" } ] }
-
示例 2
1
SDK代码示例
SDK代码示例如下。
查询资源实例。
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 |
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"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); FunctionGraphClient client = FunctionGraphClient.newBuilder() .withCredential(auth) .withRegion(FunctionGraphRegion.valueOf("<YOUR REGION>")) .build(); ShowResInstanceInfoRequest request = new ShowResInstanceInfoRequest(); ListEnterpriseResourceRequestBody body = new ListEnterpriseResourceRequestBody(); List<KvItem> listbodyMatches = new ArrayList<>(); listbodyMatches.add( new KvItem() .withKey("resource_name") .withValue("test_function") ); body.withMatches(listbodyMatches); body.withLimit("5"); 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()); } } } |
查询资源实例。
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 |
# coding: utf-8 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 = __import__('os').getenv("CLOUD_SDK_AK") sk = __import__('os').getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = FunctionGraphClient.new_builder() \ .with_credentials(credentials) \ .with_region(FunctionGraphRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowResInstanceInfoRequest() listMatchesbody = [ KvItem( key="resource_name", value="test_function" ) ] request.body = ListEnterpriseResourceRequestBody( matches=listMatchesbody, limit="5", 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) |
查询资源实例。
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 |
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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := functiongraph.NewFunctionGraphClient( functiongraph.FunctionGraphClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ShowResInstanceInfoRequest{} keyMatches:= "resource_name" valueMatches:= "test_function" var listMatchesbody = []model.KvItem{ { Key: &keyMatches, Value: &valueMatches, }, } limitListEnterpriseResourceRequestBody:= "5" withoutAnyTagListEnterpriseResourceRequestBody:= true request.Body = &model.ListEnterpriseResourceRequestBody{ Matches: &listMatchesbody, Limit: &limitListEnterpriseResourceRequestBody, WithoutAnyTag: &withoutAnyTagListEnterpriseResourceRequestBody, } response, err := client.ShowResInstanceInfo(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
ok |
400 |
Bad Request 请求错误。 |
401 |
Unauthorized 鉴权失败。 |
403 |
Forbidden 没有操作权限。 |
404 |
Not Found 找不到资源。 |
500 |
Internal Server Error 服务内部错误。 |
错误码
请参见错误码。