基于標(biāo)簽查詢資源。
接口說明
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下:
- 操作:是指具體的權(quán)限點(diǎn)。
- 訪問級(jí)別:是指每個(gè)操作的訪問級(jí)別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說明如下:
- 對(duì)于必選的資源類型,用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
tag:ListResourcesByTag | get | *全部資源 * |
| 無 |
請(qǐng)求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 地域 ID。 關(guān)于地域 ID 的詳情,請(qǐng)參見服務(wù)接入點(diǎn)。 | cn-shenzhen |
NextToken | string | 否 | 下一個(gè)查詢開始的 Token。 | caeba0bbb2be03f84eb48b699f0a**** |
MaxResult | integer | 否 | 分頁時(shí)每頁顯示的數(shù)據(jù)條數(shù)。 默認(rèn)值:50。最大值:1000。 | 50 |
ResourceType | string | 是 | 資源類型,用于查詢的過濾條件。取值:
| ALIYUN::VPC::VPC |
FuzzyType | string | 否 | 查詢操作。取值:
| EQUAL |
TagFilter.Value | string | 否 | 標(biāo)簽值,用于查詢的過濾條件。 最多支持 128 個(gè)字符,不能包含 | v1 |
TagFilter.Key | string | 是 | 標(biāo)簽鍵,用于查詢的過濾條件。 最多支持 128 個(gè)字符,不能以 | k1 |
IncludeAllTags | boolean | 否 | 是否返回資源上的標(biāo)簽信息。取值:
| False |
支持邏輯非查詢的資源類型:
- ALIYUN::ADB::CLUSTER
- ALIYUN::ALB::ACL
- ALIYUN::ALB::LOADBALANCER
- ALIYUN::ALB::SECURITYPOLICY
- ALIYUN::ALB::SERVERGROUP
- ALIYUN::ALIDNS::DOMAIN
- ALIYUN::BASTIONHOST::INSTANCE
- ALIYUN::BPSTUDIO::APPLICATION
- ALIYUN::BPSTUDIO::TEMPLATE
- ALIYUN::CAS::INSTANCE
- ALIYUN::CDN::DOMAIN
- ALIYUN::CDS::CLUSTER
- ALIYUN::CEN::BANDWIDTHPACKAGE
- ALIYUN::CEN::CEN
- ALIYUN::CS::CLUSTER
- ALIYUN::DBAUDIT::INSTANCE
- ALIYUN::DCDN::DOMAIN
- ALIYUN::DDOSBGP::INSTANCE
- ALIYUN::DDOSCOO::INSTANCE
- ALIYUN::DDS::INSTANCE
- ALIYUN::DRDS::INSTANCE
- ALIYUN::ECS::DDH
- ALIYUN::ECS::DDHCLUSTER
- ALIYUN::ECS::DISK
- ALIYUN::ECS::ENI
- ALIYUN::ECS::INSTANCE
- ALIYUN::ECS::KEYPAIR
- ALIYUN::ECS::LAUNCHTEMPLATE
- ALIYUN::ECS::SECURITYGROUP
- ALIYUN::ECS::SNAPSHOT
- ALIYUN::EDAS::APPLICATION
- ALIYUN::EDAS::CLUSTER
- ALIYUN::ELASTICSEARCH::INSTANCE
- ALIYUN::EMR::CLUSTER
- ALIYUN::EMR::FLOWPROJECT
- ALIYUN::HBR::CLIENT
- ALIYUN::HBR::HANAINSTANCE
- ALIYUN::HBR::VAULT
- ALIYUN::KVSTORE::INSTANCE
- ALIYUN::MULTIMOD::CLUSTER
- ALIYUN::OCEANBASE::INSTANCE
- ALIYUN::OOS::EXECUTION
- ALIYUN::OOS::PARAMETER
- ALIYUN::OOS::SECRETPARAMETER
- ALIYUN::OOS::STATECONFIGURATION
- ALIYUN::OOS::TEMPLATE
- ALIYUN::OSS::BUCKET
- ALIYUN::OUTBOUNDBOT::INSTANCE
- ALIYUN::POLARDB::CLUSTER
- ALIYUN::PVTZ::ZONE
- ALIYUN::RDS::INSTANCE
- ALIYUN::VPC::COMMONBANDWIDTHPACKAGE
- ALIYUN::VPC::EIP
- ALIYUN::VPC::NATGATEWAY
- ALIYUN::VPC::VPC
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"RequestId": "7D61FF74-61C2-5768-B01F-05FC97F24F35",
"NextToken": "caeba0bbb2be03f84eb48b699f0a****",
"Resources": [
{
"ResourceId": "vpc-wz9pifyuw26esxd05****",
"Tags": [
{
"Key": "k1",
"Value": "v1",
"Category": "custom"
}
]
}
]
}
錯(cuò)誤碼
HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
---|---|---|---|
400 | Invalid.MsgEndPoint | The MsgEndPoint is invalid. | MsgEndPoint非法。 |
400 | Invalid.MsgQueue | The MsgQueue is invalid. | 消息列表參數(shù)非法。 |
400 | InvalidParameter.Tags | The specified value of parameter Tags is not valid. | Tags參數(shù)非法。 |
400 | InvalidParameter.Tags | The Tags' parameter cannot be empty, and JSON parsing should adhere to the format of a Map. | 參數(shù)Tags不能為空,JSON解析需符合Map的格式,比如 {"key":"value"} |
400 | Duplicate.TagKey | The Tag.N.Key contains duplicate keys, please check the duplicate tag key. | 存在重復(fù)的標(biāo)簽鍵。 |
400 | InvalidParameter.TagKey | The TagKey parameter is invalid. The following TagKeys are invalid: %s. | 參數(shù)中存在不合法的標(biāo)簽鍵,不合法的標(biāo)簽鍵如下:%s |
400 | MetaTagKeyHasValue | The specified TagKey already bind tag value | 指定的標(biāo)簽鍵存在綁定的標(biāo)簽值 |
400 | NumberExceed.TagKeys | The maximum number of TagKeys is exceeded. | 標(biāo)簽鍵的個(gè)數(shù)超過最大限制。 |
400 | InvalidParameter.TagValue | The TagValue parameter is invalid. The following TagValues are invalid: %s. | 參數(shù)中包含不合法的標(biāo)簽值,不合法的標(biāo)簽值如下:%s |
403 | Invalid.NextToken | The parameter NextToken is invalid. | NextToken參數(shù)非法。 |
403 | InvalidParamter.NextToken | NextToken parameter is illegal. | NextToken 參數(shù)非法。 |
403 | FuzzyType.NotSupport | Fuzzy queries are not supported. | 不支持模糊查詢。 |
403 | NumberExceed.Tags | The maximum number of Tags is exceeded. | 標(biāo)簽參數(shù)數(shù)量超限。 |
403 | QuotaExceed.TagsPerResource | The maximum number of tags for each resource is exceeded. | 每個(gè)資源上的標(biāo)簽數(shù)量有限制,目前有資源已經(jīng)超限。 |
403 | Duplicate.TagKey | The Tag.N.Key contains duplicate keys. | 參數(shù)包含重復(fù)標(biāo)簽鍵。 |
403 | InvalidParameter.Key | The Key is invalid. | Key值非法。 |
403 | InvalidParameter.TagKey | The Tag.N.Key parameter is invalid. | 標(biāo)簽鍵參數(shù)非法。 |
403 | MetaTagKey.BindingResources | Binding resource exists for tag key. | 標(biāo)簽鍵存在綁定資源。 |
403 | MetaTagKeyNotFound | The meta tag key is not found. | 預(yù)置標(biāo)簽鍵不存在。 |
403 | NoPermissionKey.Category | Some keys cannot be modified because the user does not have permission. | 某些key的標(biāo)簽類型沒有操作權(quán)限。 |
403 | NoPermissionKey.Operator | You are not authorized to operate the tag key. | 該用戶沒有操作此標(biāo)簽鍵權(quán)限。 |
403 | InvalidParameter.Category | The specified Category is invalid. Valid values are Custom and System. | 標(biāo)簽類型非法,合法值為Custom,System。 |
403 | InvalidParameter.TagValue | The Tag.N.Value parameter is invalid. | 標(biāo)簽值參數(shù)非法。 |
403 | InvalidParameter.Value | The Value is invalid. | Value值非法。 |
404 | MissingParameter.Tags | You must specify Tags. | 缺少參數(shù)Tags。 |
404 | Missing.TagKey | Tag.N.Value has been specified and you must specify Tag.N.Key. | 一對(duì)鍵值對(duì),對(duì)應(yīng)的TagValue缺失相同N的TagKey。 |
404 | MissingParameter.Key | The Key must not be empty. | Key值為空。 |
404 | MissingParameter.TagKey | You must specify TagKey. | 標(biāo)簽鍵參數(shù)不可為空。 |
404 | MissingParameter.TagKeyValueParamList | The parameter TagKeyValueParamList must not be null. | 缺少參數(shù)TagKeyValueParamList。 |
404 | MissingParameter.Value | The Value must not be empty. | Value值為空。 |
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2022-12-06 | API 內(nèi)部配置變更,不影響調(diào)用 | 查看變更詳情 |
2022-11-21 | API 內(nèi)部配置變更,不影響調(diào)用 | 查看變更詳情 |