根据标签检索资源

接口说明


根据标签检索实例、密钥对等资源。


推荐使用API Explorer调试

API Explorer支持接口在线可视化调用,同时自动生成动态代码示例,搭配OpenAPI SDK无需计算签名实现接口快速集成。

URL

POST https://ecloud.10086.cn/api/openapi-instance/v4/tags/resources

请求参数

Body

参数名称
类型
必填
描述
tagsResourcesReq
TagsResourcesReq
是

tagsResourcesReq

resourceType
string
是

资源类型。取值范围:

  • VM:云主机实例。
  • DDHVM:宿主机上的云主机实例。
  • KeyPair:密钥对。
page
integer(int32)
否

列表分页页数,起始页为1。

pageSize
integer(int32)
否

列表分页每页大小,默认值为10,最大值为100。

tags
<Tag> array
是

标签列表。

key
string
是

标签键,仅支持中英文、数字、中划线、下划线,长度1-127位之间,不能以ecloud开头。

value
string
是

标签值,仅支持数字、中英文、中划线、下划线,长度在1~255位之间,不能以ecloud开头。

请求示例

POST https://ecloud.10086.cn/api/openapi-instance/v4/tags/resources
{
	"resourceType":"keyPair",
	"tags":[
		{
			"key":"test-1105",
			"value":"3"
		}
	],
	"pageSize":10,
	"page":1
}

返回参数

返回码:200
OK
参数名称
类型
描述
body
TagsResources

请求成功时返回的数据。

resourceIds
<string> array

资源ID列表。

total
integer(int32)

满足查询条件的总个数。

errorCode
string

统一错误码。

errorMessage
string

页面国际化错误提示。

errorParams
<string> array

统一错误码的自定义参数。

requestId
string

每个请求的序列号。

state
enum(OK,ERROR,EXCEPTION,ALARM,FORBIDDEN)

返回状态码。返回正常:OK,返回错误:ERROR,返回异常:EXCEPTION,需要告警实现的:ALARM,禁止访问:FORBIDDEN。

返回示例

返回码:200
OK
{
	"requestId":"reqId-7c752d9a-6a0f-43fd-a0d6-05cb323f2ef8",
	"state":"OK",
	"body":{
		"resourceIds":[
			"32396a06-e04d-49f5-9037-02f8885ac3a8",
			"bf5037f5-c7c9-4701-b2b9-b40537327ef6"
		],
		"total":2
	}
}
本文档内容整理自移动云官方帮助中心(查看原文),仅供参考。