ListResourceRelationships - 查询当前账号的资源关系

查询当前账号下有权限访问的资源关系。

接口说明

  • 仅能查询当前账号下有权限访问的资源关系。
  • ListResourceRelationships 接口默认最多返回 20 条数据,您可以通过指定MaxResults参数调整最大返回条目数。
  • 如果返回结果中不存在NextToken,则表示没有更多数据。否则,表示还有更多数据。如果想要查询后续页,需要将 ListResourceRelationships 接口的NextToken参数设置为上一次返回结果中获取到的NextToken 。如果未输入NextToken参数,查询时默认返回第一页的数据。
  • 通过设置一个或多个过滤条件,可以精确资源关系的查询范围。支持的过滤参数以及匹配方式见下文。多个过滤条件之间是逻辑与AND的关系,只有同时满足所有过滤条件的资源才会被返回。每个过滤条件内部是逻辑或OR的关系,只要满足任意一个过滤条件值的资源都会被返回。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
resourcecenter:ListResourceRelationshipslist
*全部资源
*

请求参数

名称类型必填描述示例值
RegionIdstring

资源地域 ID。

cn-hangzhou
ResourceTypestring

资源类型。

ACS::ACK::Cluster
ResourceIdstring

资源 ID。

m-eb3hji****
RelatedResourceFilterarray<object>

相关资源过滤条件。

object

相关资源过滤条件。

Keystring

过滤条件键。取值见下方支持的过滤参数

RelatedResourceRegionId
Valuearray

过滤条件值。

string

过滤条件值。

cb-shanghai
MatchTypestring

匹配方式。

Equals
NextTokenstring

查询返回结果下一页的令牌。

eyJzZWFyY2hBZnRlcnMiOlsiMTAwMTU2Nzk4MTU1OSJd****
MaxResultsinteger

每页的最大数据条数。

取值范围:1~500。

默认值:20。

10

支持的过滤参数

参数描述支持的匹配类型
RelatedResourceRegionId相关资源地域 ID。Equals
RelatedResourceType相关资源类型。Equals
RelatedResourceId相关资源 ID。Equals

返回参数

名称类型描述示例值
object

返回参数。

RequestIdstring

请求 ID。

682A3004-38E3-5122-9A11-CCDFAB9C3C4F
MaxResultsinteger

每页的最大数据条数。

10
NextTokenstring

查询返回结果下一页的令牌。

eyJzZWFyY2hBZnRlcnMiOlsiMTAwMTU2Nzk4MTU1OSJd****
ResourceRelationshipsarray<object>

相关资源列表。

ResourceRelationshipobject

相关资源列表。

RegionIdstring

资源地域 ID。

cn-hangzhou
ResourceTypestring

资源类型。

ACS::ACK::Cluster
ResourceIdstring

资源 ID。

m-eb3hji****
RelatedResourceRegionIdstring

相关资源地域 ID。

cn-shanghai
RelatedResourceTypestring

相关资源类型。

ACS::VPC::VPC
RelatedResourceIdstring

相关资源 ID。

vpc-uf6m5okksddm6c9lh7***

示例

正常返回示例

JSON格式

{
  "RequestId": "682A3004-38E3-5122-9A11-CCDFAB9C3C4F",
  "MaxResults": 10,
  "NextToken": "eyJzZWFyY2hBZnRlcnMiOlsiMTAwMTU2Nzk4MTU1OSJd****",
  "ResourceRelationships": [
    {
      "RegionId": "cn-hangzhou",
      "ResourceType": "ACS::ACK::Cluster",
      "ResourceId": "m-eb3hji****",
      "RelatedResourceRegionId": "cn-shanghai",
      "RelatedResourceType": "ACS::VPC::VPC",
      "RelatedResourceId": "vpc-uf6m5okksddm6c9lh7***"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400NoPermissionYou are not authorized to perform this operation.无操作权限。
400InvalidParameter.MaxResultsThe specified parameter MaxResults is not valid.参数 MaxResults 不合法。
400InvalidParameter.RelatedResourceFilterMatchTypeThe specified parameter RelatedResourceFilterMatchType.n.MatchType is not valid.参数 RelatedResourceFilterMatchType.n.MatchType 不合法。
400MissingParameter.RelatedResourceFilterValueYou must specify RelatedResourceFilterValue.n.Value.缺少参数 RelatedResourceFilterValue.n.Value。
400InvalidParameter.RelatedResourceFilterKeyThe specified parameter RelatedResourceFilterMatchType.n.RelatedResourceFilterKey is not valid.参数 RelatedResourceFilterMatchType.n.RelatedResourceFilterKey 不合法。
404MissingParameter.RegionIdThe specified parameter RegionId is missing.参数 RegionId 缺失。
404MissingParameter.ResourceTypeThe specified parameter ResourceType is missing.参数 ResourceType 缺失。
404MissingParameter.ResourceIdThe specified parameter ResourceId is missing.参数 ResourceId 缺失。
404ExceedLimit.RelatedResourceFilterThe maximum length of RelatedResourceFilter is exceeded.参数 RelatedResourceFilter 数量超出上限。
409InvalidParameter.ResourceTypeThe specified parameter ResourceType is not valid.参数 ResourceType 不合法。
409ExceedLimit.RelatedResourceFilterValueThe number of objects specified in the RelatedResourceFilterValue parameter exceeds the upper limit.参数 RelatedResourceFilterValue 数量超出上限。

访问错误中心查看更多错误码。