Querying Associated Resources
Function
This API is used to query associated resources.
Calling Method
For details, see Calling APIs.
URI
GET /v1.0/associated-resources/{resource_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
resource_id |
Yes |
String |
Resource ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
region_id |
Yes |
String |
Region ID. |
resource_type |
Yes |
String |
Resource type. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. EPS is a global service. When calling the IAM API to obtain a user token, set scope to domain. The value of X-Subject-Token in the response header is the user token. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
id |
String |
Resource ID. |
name |
String |
Resource name. |
type |
String |
Type of associated resources. |
associated_resources |
Array of AssociatedResourceListResponse objects |
Associated resources. |
errors |
Array of ResourceErrorListResponse objects |
List of error information. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Resource ID. |
name |
String |
Resource name. |
eip |
String |
EIP information. |
resource_type |
String |
Resource type. |
Parameter |
Type |
Description |
---|---|---|
project_id |
String |
Project resource ID. |
resource_type |
String |
Resource type. |
resource_id |
String |
Resource ID. |
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Error request information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Error request information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 402
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Error request information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Error request information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Error request information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 405
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Error request information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 406
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Error request information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 407
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Error request information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 408
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Error request information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 409
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Error request information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Error request information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 501
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Error request information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 502
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Error request information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 503
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Error request information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 504
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Error request information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Example Requests
Querying associated resources
GET https://{Endpoint}/v1.0/associated-resources/{resource_id}
Example Responses
Status code: 200
OK
{ "id" : "8787d3e2-338d-4cb3-b683-fcadfd368d2d", "name" : "test", "type" : "ecs", "associated_resources" : [ { "id" : "1f2d6f80-29e4-4cca-bed4-571932f00e31", "name" : "disk-test", "eip" : "", "resource_type" : "disk" } ], "errors" : [ { "project_id" : "", "resource_type" : "", "resource_id" : "", "error_code" : "", "error_msg" : "" } ] }
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 46 |
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.eps.v1.region.EpsRegion; import com.huaweicloud.sdk.eps.v1.*; import com.huaweicloud.sdk.eps.v1.model.*; public class ShowAssociatedResourcesSolution { 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); EpsClient client = EpsClient.newBuilder() .withCredential(auth) .withRegion(EpsRegion.valueOf("<YOUR REGION>")) .build(); ShowAssociatedResourcesRequest request = new ShowAssociatedResourcesRequest(); request.withResourceId("{resource_id}"); try { ShowAssociatedResourcesResponse response = client.showAssociatedResources(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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import GlobalCredentials from huaweicloudsdkeps.v1.region.eps_region import EpsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkeps.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 = EpsClient.new_builder() \ .with_credentials(credentials) \ .with_region(EpsRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowAssociatedResourcesRequest() request.resource_id = "{resource_id}" response = client.show_associated_resources(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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global" eps "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eps/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eps/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eps/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 := eps.NewEpsClient( eps.EpsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ShowAssociatedResourcesRequest{} request.ResourceId = "{resource_id}" response, err := client.ShowAssociatedResources(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 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
402 |
Payment Required |
403 |
Forbidden |
404 |
Not Found |
405 |
Method Not Allowed |
406 |
Not Acceptable |
407 |
Proxy Authentication Required |
408 |
Request Timeout |
409 |
Conflict |
500 |
Internal Server Error |
501 |
Not Implemented |
502 |
Bad Gateway |
503 |
Service Unavailable |
504 |
Gateway Timeout |
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