GetResources - 查询资源及资源绑定标签信息--资源管理-火山引擎

文档中心

立即注册

导航

GetResources - 查询资源及资源绑定标签信息

最近更新时间：2025.06.25 14:19:10首次发布时间：2023.08.24 21:41:31

查询资源及资源绑定标签信息

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	GetResources	要执行的操作，取值：GetResources。
Version	String	是	2022-06-01	API的版本，取值：2022-06-01。
ResourceTypeFilters.N	Array of String	否	ResourceTypeFilters.1=ecs:instance&ResourceTypeFilters.2=vpc:subnet	资源类型筛选条件。必须是'${service}:${resourceType}'的格式，最多允许传入10个资源类型筛选条件
TagFilters.N.Values.N	Array of String	否	tagvalue	标签值筛选条件
ResourceTrnList.N	Array of String	否	ResourceTrnList.1=trn:ecs:cn-guilin-boe:2000000000:instance/i-ybndd8fy3rkdvbtuguu9&ResourceTrnList.2=trn:ecs:cn-guilin-boe:2000000000:instance/i-ybn3rkdvbtuguu9	资源TRN列表。传入的资源TRN个数必须在[0,100]区间
TagFilters.N.Key	Array of String	否	tagkey	标签键筛选条件。最多只允许传入50个标签键筛选条件
MaxResults	Integer	否	10	预期获取的资源数量。传入的值必须在(0,1000]区间
NextToken	String	否	eyJOZXh0SW5mbyI6IntcIklEXCI6NzgzODg2MzV9IiwiU2lnblRpbWUiOjE2OTIyNjUwODksIlNpZ25hdHVyZSI6IjQ4ZTc2OWRkZDcxMmNhNDJmNzkxNjI2NDRiZmZlODA3MzZhNmVmMDVjM2FlNWEyYmZjY2I3YjIwZTI3MTY2NGEifQ==	请求下一页资源数据的Token。不传则认为是获取第一页的数据

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
NextToken	String	eyJOZXh0SW5mbyI6IntcIklEXCI6NzgzODg2MzV9IiwiU2lnblRpbWUiOjE2OTIyNjUwODksIlNpZ25hdHVyZSI6IjQ4ZTc2OWRkZDcxMmNhNDJmNzkxNjI2NDRiZmZlODA3MzZhNmVmMDVjM2FlNWEyYmZjY2I3YjIwZTI3MTY2NGEifQ==	请求下一页数据的NextToken参数，返空则代表没有更多的数据
ResourceTagMappingList	Array of Object	[{ "ResourceTrn": "trn:ecs:cn-guilin-boe:2000000000:instance/i-ybndd8fy3rkdvbtuguu9", "ResourceID": "i-ybndd8fy3rkdvbtuguu9", "ResourceType": "instance", "ServiceName": "ecs", "Region": "cn-beijing", "Tags": [ { "Key": "tagkey", "Value": "tagvalue", "Type": "Custom" } ] } ]	资源标签映射关系

请求示例

GET /?Action=GetResources&Version=2022-06-01&ResourceTypeFilters.1=ecs:instance&ResourceTypeFilters.2=vpc:subnet&TagFilters.1.Values.1=tagvalue&ResourceTrnList.1=trn:ecs:cn-guilin-boe:2000000000:instance/i-ybndd8fy3rkdvbtuguu9&ResourceTrnList.2=trn:ecs:cn-guilin-boe:2000000000:instance/i-ybn3rkdvbtuguu9&TagFilters.1.Key=wstestkey-auto&TagFilters.1.Values.1=wstestvalue-auto&MaxResults=10&NextToken=eyJOZXh0SW5mbyI6IntcIklEXCI6NzgzODg2MzV9IiwiU2lnblRpbWUiOjE2OTIyNjUwODksIlNpZ25hdHVyZSI6IjQ4ZTc2OWRkZDcxMmNhNDJmNzkxNjI2NDRiZmZlODA3MzZhNmVmMDVjM2FlNWEyYmZjY2I3YjIwZTI3MTY2NGEifQ== HTTP/1.1
Host: open.volcengineapi.com
X-Date: 20250620T112154Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250620/cn-beijing/tag/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f


Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250620/cn-beijing/tag/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202506201926520870210830704F0C48",
    "Action": "GetResources",
    "Version": "2022-06-01",
    "Service": "tag",
    "Region": "cn-beijing"
  },
  "Result": {
    "NextToken": "eyJOZXh0SW5mbyI6IntcIklEXCI6NzgzODg2MzV9IiwiU2lnblRpbWUiOjE2OTIyNjUwODksIlNpZ25hdHVyZSI6IjQ4ZTc2OWRkZDcxMmNhNDJmNzkxNjI2NDRiZmZlODA3MzZhNmVmMDVjM2FlNWEyYmZjY2I3YjIwZTI3MTY2NGEifQ==",
    "ResourceTagMappingList": [
      {
        "ResourceTrn": "6BWxFE",
        "ResourceID": "7ZAj98R",
        "ResourceType": "tWWFskWaEb",
        "ServiceName": "2KeY",
        "Region": "f5dkKE8w6y",
        "Tags": [
          {
            "Key": "TQs",
            "Value": "viD9pfP1Sp",
            "Type": "X9Se94R"
          }
        ]
      }
    ]
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	Invalid.%s	The parameter %s is invalid.	请求参数不合法。具体不合法参数见错误描述信息，请参阅API文档查看对应参数的传参要求
400	InvalidParameter.%s	The specified parameter %s is invalid.	请求参数不合法。具体不合法参数见错误描述信息，请参阅API文档查看对应参数的传参要求
400	InvalidParameter.%s.%s	The specified parameter %s.%s is invalid.	请求参数不合法。具体不合法参数见错误描述信息，请参阅API文档查看对应参数的传参要求
500	InternalError	The request processing has failed because of an internal error.	服务内部系统错误。往往是由服务内部组件异常、网络异常或服务自身bug导致，请及时联系相关管理员进行排查确认