SearchResources - 搜索当前账号的资源--资源管理-火山引擎

文档中心

立即注册

导航

SearchResources - 搜索当前账号的资源

最近更新时间：2025.06.03 19:48:49首次发布时间：2024.06.24 21:35:41

搜索当前账号的资源

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	SearchResources	要执行的操作，取值：SearchResources。
Version	String	是	2023-06-01	API的版本，取值：2023-06-01。
Filter	Array of Object	否	[ { "Key": "Region", "Values": [ "cn-beijing" ] } ]	过滤条件
SortBy	String	否	CreateTime	排序条件。取值： CreateTime，表示按资源创建时间排序
SortOrder	String	否	Asc	排序顺序。取值：Asc、Desc；默认Asc
MaxResults	Integer	否	10	每页最大数据条数；取值范围：1~100，默认值：10
NextToken	String	否	eyJOZXh0SW5mbyI6IntcIkluZm9zXCI6XCJbMTY5NDcxNjkwNDAwMCxcXFwidHJuOm1vY2tfcHJvdmlkZXI6Y24tYmVpamluZzoyMTAwMDAxMjU1Omluc3RhbmNlL2ktM3RkYXNmcWVydnNpOS0xXFxcIl1cIn0iLCJTaWduVGltZSI6MTcxODMzNzU5OCwiU2lnbmF0dXJlIjoiOTZhMzk2YWY1ZTg5YjMyYWUyYmY5ZGZiYzA2YTg0MGMifQ	查询返回结果下一页的token

返回参数

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

参数	类型	示例值	描述
Resources	Array of Object	i-3tdasfqervsi9	资源信息
NextToken	String	eyJOZXh0SW5mbyI6IntcIkluZm9zXCI6XCJbMTY5NDcxNjkwNDAwMCxcXFwidHJuOm1vY2tfcHJvdmlkZXI6Y24tYmVpamluZzoyMTAwMDAxMjU1Omluc3RhbmNlL2ktM3RkYXNmcWVydnNpOS0xXFxcIl1cIn0iLCJTaWduVGltZSI6MTcxODMzNzU5OCwiU2lnbmF0dXJlIjoiOTZhMzk2YWY1ZTg5YjMyYWUyYmY5ZGZiYzA2YTg0MGMifQ	下一页 token

请求示例

POST /?Action=SearchResources&Version=2023-06-01 HTTP/1.1
Host: https://resourcecenter.volcengineapi.com/
Content-Type: application/json; charset=UTF-8
X-Date: 20240614T035813Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240614/cn-beijing/resourcecenter/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "Filter": [
    {
      "Key": "Region",
      "Values": [
        "cn-beijing"
      ]
    }
  ],
  "MaxResults": 10
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2024061411595832A7B71006B56111CF6B",
        "Action": "SearchResources",
        "Version": "2023-06-01",
        "Service": "resourcecenter",
        "Region": "cn-beijing"
    },
    "Result": {
        "Resources": [
            {
                "Service": "ecs",
                "ResourceType": "instance",
                "Region": "cn-beijing",
                "ResourceID": "i-3tdasfqervsi9",
                "AccountID": 2123456789,
                "ResourceName": "i-3tdasfqervsi9",
                "CreateTime": "2023-09-14T18:41:44Z",
                "ProjectName": "default",
                "Tags": []
            }
        ],
        "NextToken": "eyJOZXh0SW5mbyI6IntcIkluZm9zXCI6XCJbMTY5NDcxNjkwNDAwMCxcXFwidHJuOm1vY2tfcHJvdmlkZXI6Y24tYmVpamluZzoyMTAwMDAxMjU1Omluc3RhbmNlL2ktM3RkYXNmcWVydnNpOS0xXFxcIl1cIn0iLCJTaWduVGltZSI6MTcxODMzNzU5OCwiU2lnbmF0dXJlIjoiOTZhMzk2YWY1ZTg5YjMyYWUyYmY5ZGZiYzA2YTg0MGMifQ"
    }
}

错误码

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

状态码	错误码	错误信息	说明
400	InvalidParameter	The specified parameter %s is invalid.	请求参数错误
400	ServiceNotEnabled	ResourceCenter Service is not enabled.	资源中心服务暂未开通
400	InvalidParameter.Filter.Value	The specified parameter Filter.Value is invalid.	请求参数 Filter.Value 不合法
400	InvalidParameter.Filter.Key	The specified parameter Filter.Key is invalid.	请求参数 Filter.Key 不合法
400	InvalidParameter.Filter.MatchType	The specified parameter Filter.MatchType is invalid.	请求参数 Filter.MatchType 不合法
400	InvalidParameter.MaxResults	The specified parameter MaxResults is invalid.	请求参数 MaxResults 不合法
400	InvalidParameter.NextToken	The specified parameter NextToken is invalid.	请求参数 NextToken 不合法
400	InvalidParameter.SortBy	The specified parameter SortBy is invalid.	请求参数 SortBy 不合法
400	InvalidParameter.SortOrder	The specified parameter SortOrder is invalid.	请求参数 SortOrder 不合法
500	InternalError	The request has failed due to an unknown error.	内部服务错误，请稍后重试