機能の概要
このAPIは、現在の組織のタグリストを照会し、タグキーと対応するタグ値の集合を返します。
呼び出しの説明
API制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを持っている必要があります。AccessKey IDとAccessKey Secretの取得方法については、アクセスキーの管理をご参照ください。
リクエストパス
GET /api/v2/tags
リクエストパラメータ
Query
パラメータ名 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| orgId | String | はい | 組織ID | uk******** |
戻り結果
名前 |
型 |
説明 |
サンプル値 |
|---|---|---|---|
| requestId | String | リクエストID | - |
| data | Array | タグリスト | - |
| data[].id | Integer | タグキーID（外側） | 217 |
| data[].tagKey | String | タグキーの値 | bxtest-key |
| data[].tagValueList | Array | そのタグキーに対応する値の集合 | - |
| data[].tagValueList[].id | Integer | タグ値のID（内側）、完全なタグで使用されるIDを表す | 244 |
| data[].tagValueList[].tagKey | String | タグキー | bxtest-key |
| data[].tagValueList[].tagValue | String | タグ値 | bxtest-value |
| success | Boolean | 成功したかどうか | true |
例
リクエスト例
curl --digest -u 'ak:sk' \
-X GET \
'https://api-cloud.oceanbase.com/api/v2/tags?orgId=uk********'
戻り値の例
JSON 形式
{
"data": [
{
"id": 217,
"tagKey": "bxtest-key",
"tagValueList": [
{
"id": 244,
"tagKey": "bxtest-key",
"tagValue": "bxtest-value"
}
]
}
],
"requestId": "",
"success": true
}