更新时间:2024-06-13 GMT+08:00
分享

列举资源关系详情

功能介绍

指定资源ID,查询该资源与其他资源的关联关系,可以指定关系方向为“in”或者“out”,需要当账号有rms:resources:getRelation权限。资源关系依赖开启资源记录器。

调用方法

请参见如何调用API

URI

GET /v1/resource-manager/domains/{domain_id}/all-resources/{resource_id}/relations

表1 路径参数

参数

是否必选

参数类型

描述

domain_id

String

账号ID。

最大长度:36

resource_id

String

资源ID。

最大长度:512

表2 Query参数

参数

是否必选

参数类型

描述

direction

String

资源关系的指向。

limit

Integer

最大的返回数量。

最小值:1

最大值:1000

marker

String

分页参数,通过上一个请求中返回的marker信息作为输入,获取当前页。

最小长度:4

最大长度:400

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Security-Token

String

如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

relations

Array of ResourceRelation objects

资源关系列表。

page_info

PageInfo object

分页对象。

表5 ResourceRelation

参数

参数类型

描述

relation_type

String

关系类型。

from_resource_type

String

源资源类型。

to_resource_type

String

目的资源类型。

from_resource_id

String

源资源ID。

to_resource_id

String

目的资源ID。

表6 PageInfo

参数

参数类型

描述

current_count

Integer

当前页的资源数量。

最小值:0

最大值:200

next_marker

String

下一页的marker。

最小长度:4

最大长度:400

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息内容。

状态码: 403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息内容。

状态码: 404

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息内容。

状态码: 500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息内容。

请求示例

GET https://{endpoint}/v1/resource-manager/domains/{domain_id}/all-resources/{resource_id}/relations?direction=out

响应示例

状态码: 200

操作成功。

{
  "relations" : [ {
    "relation_type" : "isAttachedTo",
    "from_resource_type" : "ecs.cloudservers",
    "to_resource_type" : "evs.volumes",
    "from_resource_id" : "6af96128-d58d-426c-91e0-b38144c0f112",
    "to_resource_id" : "0075ed19-59dd-49be-961d-117bb6fbfd3e"
  }, {
    "relation_type" : "contains",
    "from_resource_type" : "ecs.cloudservers",
    "to_resource_type" : "vpc.publicips",
    "from_resource_id" : "6af96128-d58d-426c-91e0-b38144c0f112",
    "to_resource_id" : "3813d6d3-ef88-47b1-b343-cdf6390c6dcb"
  }, {
    "relation_type" : "isAssociatedWith",
    "from_resource_type" : "ecs.cloudservers",
    "to_resource_type" : "vpc.securityGroups",
    "from_resource_id" : "6af96128-d58d-426c-91e0-b38144c0f112",
    "to_resource_id" : "8cca3002-00af-4812-a853-b7a6fbee06a4"
  }, {
    "relation_type" : "isAttachedTo",
    "from_resource_type" : "ecs.cloudservers",
    "to_resource_type" : "evs.volumes",
    "from_resource_id" : "6af96128-d58d-426c-91e0-b38144c0f112",
    "to_resource_id" : "f4a107eb-4c6d-4dc8-88d8-de337923956f"
  }, {
    "relation_type" : "isContainedIn",
    "from_resource_type" : "ecs.cloudservers",
    "to_resource_type" : "vpc.vpcs",
    "from_resource_id" : "6af96128-d58d-426c-91e0-b38144c0f112",
    "to_resource_id" : "ff13d70d-17e5-4ec8-945a-c874e0db99d3"
  } ],
  "page_info" : {
    "current_count" : 5,
    "next_marker" : null
  }
}

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
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 ShowResourceRelationsDetailSolution {

    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();
        ShowResourceRelationsDetailRequest request = new ShowResourceRelationsDetailRequest();
        request.withDirection(ShowResourceRelationsDetailRequest.DirectionEnum.fromValue("<direction>"));
        request.withLimit(<limit>);
        request.withMarker("<marker>");
        try {
            ShowResourceRelationsDetailResponse response = client.showResourceRelationsDetail(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
# 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 = ShowResourceRelationsDetailRequest()
        request.direction = "<direction>"
        request.limit = <limit>
        request.marker = "<marker>"
        response = client.show_resource_relations_detail(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
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.ShowResourceRelationsDetailRequest{}
	request.Direction = model.GetShowResourceRelationsDetailRequestDirectionEnum().<DIRECTION>
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	markerRequest:= "<marker>"
	request.Marker = &markerRequest
	response, err := client.ShowResourceRelationsDetail(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

操作成功。

400

输入参数不合法。

403

用户认证失败。

404

资源未找到。

500

服务器内部错误。

错误码

请参见错误码

相关文档