Querying a Resource
Function
This API is used to query details of a resource based on its ID. You must have the rms:resources:get permission. For example, to query ECSs whose resource type is ecs.cloudservers, you must set provider to ecs and type to cloudservers in the request. For details about the cloud services (provider) and resource types (type), see "Appendix-Supported Services and Resource Types".
Calling Method
For details, see Calling APIs.
URI
GET /v1/resource-manager/domains/{domain_id}/provider/{provider}/type/{type}/resources/{resource_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
domain_id |
Yes |
String |
Specifies tags. Maximum: 36 |
provider |
Yes |
String |
Specifies the cloud service name. Maximum: 20 |
type |
Yes |
String |
Specifies the resource type. Maximum: 32 |
resource_id |
Yes |
String |
Specifies the resource ID. Maximum: 512 |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
No |
String |
Specifies the invoker's token. |
X-Security-Token |
No |
String |
Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
id |
String |
Specifies the resource ID. |
name |
String |
Specifies the resource name. |
provider |
String |
Specifies the cloud service name. |
type |
String |
Specifies the resource type. |
region_id |
String |
Specifies the region ID. |
project_id |
String |
Specifies the project ID in IaaS OpenStack. |
project_name |
String |
Specifies the project name in IaaS OpenStack. |
ep_id |
String |
Specifies the enterprise project ID. |
ep_name |
String |
Specifies the name of an enterprise project. |
checksum |
String |
Specifies the resource checksum. |
created |
String |
Specifies the time when the resource was created. |
updated |
String |
Specifies the time when the resource was updated. |
provisioning_state |
String |
Specifies the status of a resource operation. |
state |
String |
Resource state. The value can be normal or deleted. |
tags |
Map<String,String> |
Specifies the resource tag. |
properties |
Map<String,Object> |
Specifies the detailed properties of the resource. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Specifies the error code. |
error_msg |
String |
Specifies the error message. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Specifies the error code. |
error_msg |
String |
Specifies the error message. |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Specifies the error code. |
error_msg |
String |
Specifies the error message. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Specifies the error code. |
error_msg |
String |
Specifies the error message. |
Example Requests
GET https://{endpoint}/v1/resource-manager/domains/059b5c937100d3e40ff0c00a7675a0a0/provider/ecs/type/cloudservers/resources/00337e93-82d1-40ca-911f-07cff94587cc
Example Responses
Status code: 200
Operation succeeded.
{ "id" : "00337e93-82d1-40ca-911f-07cff94587cc", "name" : "dev_machine", "provider" : "ecs", "type" : "cloudservers", "region_id" : "regionid4", "project_id" : "39c2af998c334ed6bcbb75b27318f7cc", "project_name" : "project_name", "ep_id" : "0", "ep_name" : "default", "checksum" : "3a0075409edb156a74e041b7479f0d5993be1d62b4ccd2af3a1dd01ec80c8b39", "created" : "2019-11-20T06:24:43Z", "updated" : "2020-07-17T08:30:52Z", "provisioning_state" : "Succeeded", "tags" : { "usage" : "Display" }, "properties" : { "status" : "ACTIVE", "osextsrvattr" : { "host" : "regionid4a-pod01.regionid4", "instanceName" : "instance-0009cb50", "hostName" : "dev-machine", "hypervisorHostName" : "nova001@2", "kernelId" : "", "ramdiskId" : "", "reservationId" : "r-hhux9o7m", "rootDeviceName" : "/dev/vda", "launchIndex" : 0 }, "progress" : 0, "hostId" : "3c381dcfc3e628c1a504ad94ba8c4e89081306455273701333f32921", "hostName" : "dev-machine", "hostStatus" : "UP", "locked" : false, "userId" : "e311190745e94cc09d62d5779e55912d", "flavor" : { "disk" : "0", "name" : "Si2.large.2", "id" : "Si2.large.2", "vcpus" : "2", "ram" : "4096" }, "securityGroup" : [ { "name" : "default", "id" : "5d55b397-ad9c-462d-af72-6599cb941c49" } ], "addresses" : [ { "OsExtIpsType" : "fixed", "OsExtIpsPortId" : "f2fa750a-e2ab-434f-b14a-bfe7c8cea0cc", "addr" : "192.168.1.212", "version" : 4, "OsExtIpsMacAddr" : "fa:16:3e:6e:cf:33" } ], "accessIpv4" : "", "accessIpv6" : "", "configDrive" : "", "metadata" : { "chargingMode" : "0", "meteringImageType" : "private", "imageName" : "resource-manager-devmachine-template", "meteringImageId" : "9bcaace4-b8da-4008-a352-3f72e1f25333", "meteringResourcesPerCode" : "si2.large.2.linux", "vpcId" : "cf403ef5-90df-4e7e-829d-5d21b1cb7d1e", "osBit" : "64", "osType" : "Linux" }, "OsExtStsVmState" : "active", "OsExtStsPowerState" : 1, "ExtVolumesAttached" : [ { "bootIndex" : "0", "id" : "010d940e-a73e-417b-85ae-51b76c0d2ba0", "device" : "/dev/vda" } ], "OsDcfDiskConfig" : "MANUAL", "OsSrvUsgLaunchedAt" : "2019-11-20T06:24:56.000000", "OsExtAz" : "regionid4a" } }
SDK Sample Code
The SDK sample code is as follows.
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 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.GlobalCredentials; 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.config.v1.region.ConfigRegion; import com.huaweicloud.sdk.config.v1.*; import com.huaweicloud.sdk.config.v1.model.*; public class ShowResourceByIdSolution { 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 GlobalCredentials() .withAk(ak) .withSk(sk); ConfigClient client = ConfigClient.newBuilder() .withCredential(auth) .withRegion(ConfigRegion.valueOf("<YOUR REGION>")) .build(); ShowResourceByIdRequest request = new ShowResourceByIdRequest(); try { ShowResourceByIdResponse response = client.showResourceById(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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import GlobalCredentials from huaweicloudsdkconfig.v1.region.config_region import ConfigRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkconfig.v1 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"] credentials = GlobalCredentials(ak, sk) client = ConfigClient.new_builder() \ .with_credentials(credentials) \ .with_region(ConfigRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowResourceByIdRequest() response = client.show_resource_by_id(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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global" config "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/config/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/config/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/config/v1/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 := global.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := config.NewConfigClient( config.ConfigClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ShowResourceByIdRequest{} response, err := client.ShowResourceById(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
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 |
Operation succeeded. |
400 |
Invalid parameters. |
403 |
User authentication failed. |
404 |
Resources not found. |
500 |
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.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot