Alibaba Cloud サービスからのログの収集ルールを一覧表示します。
操作説明
この API 操作は、中国 (上海) 、シンガポール、および河源自動車コンプライアンスクラウド (cn-heyuan-acdr-1) のリージョンにあるエンドポイントでのみ利用できます。
今すぐお試しください
テスト
RAM 認証
リクエスト構文
GET /collectionpolicy HTTP/1.1リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| productCode |
string |
任意 |
Alibaba Cloud サービスのコード。 |
oss |
| dataCode |
string |
任意 |
ログタイプのコード。 |
access_log |
| policyName |
string |
任意 |
収集ルールの名前。 |
your_log_policy |
| size |
integer |
任意 |
各ページで返される収集ルールの数。 デフォルト値: 50。 最大値: 100。 |
50 |
| offset |
integer |
任意 |
クエリを開始する行。 デフォルト値: 0。 |
0 |
| instanceId |
string |
任意 |
インスタンス ID。 このパラメーターを指定して、特定のインスタンスに一致するルールをクエリします。 このパラメーターを使用する場合は、productCode と dataCode も指定する必要があります。 |
your-test-bucket1 |
| centralProject |
string |
任意 |
集中データシッピングの宛先プロジェクト。 このパラメーターを指定して、このプロジェクトにデータをシッピングするように構成されているルールの数をクエリします。 |
your-central-project1 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
| headers |
object |
||
| Content-Type |
string |
||
| Server |
string |
||
| Content-Length |
string |
||
| Date |
string |
||
| Connection |
string |
||
| x-log-requestid |
string |
||
|
object |
応答本文。 |
||
| totalCount |
integer |
収集ルールの総数。 |
1 |
| currentCount |
integer |
現在のページで返される収集ルールの数。 |
1 |
| data |
array<object> |
現在のページで返される収集ルール。 |
|
|
object |
収集ルールの詳細。 |
||
| productCode |
string |
Alibaba Cloud サービスのコード。 |
oss |
| dataCode |
string |
ログタイプのコード。 |
access_log |
| policyName |
string |
収集ルールの名前。 |
your_log_policy |
| enabled |
boolean |
収集ルールが有効かどうかを示します。 |
true |
| policyConfig |
object |
収集ルールの構成。 |
|
| resourceMode |
string |
リソース収集モード。 |
all |
| regions |
array |
インスタンスが属するリージョン。 |
|
|
string |
リージョン ID。 |
cn-hangzhou |
|
| instanceIds |
array |
インスタンスの ID。 |
|
|
string |
インスタンス ID。 |
your-test-bucket1 |
|
| resourceTags |
object |
リソースタグ。 |
{"tag1":"value1","tag2":"value2"} |
| centralizeEnabled |
boolean |
集中データシッピングが有効かどうかを示します。 |
false |
| centralizeConfig |
object |
集中データシッピングの構成。 |
|
| destRegion |
string |
集中データシッピングの宛先リージョン。 |
cn-beijing |
| destProject |
string |
集中データシッピングの宛先プロジェクト。 |
your-sls-project-in-beijing |
| destLogstore |
string |
集中データシッピングの宛先 Logstore。 |
your-sls-logstore-in-beijing |
| destTTL |
integer |
集中データシッピングの宛先 Logstore のデータ保持期間。 単位: 日。 |
0 |
| resourceDirectory |
object |
リソースディレクトリの構成。 構成が利用できない場合、このパラメーターは空です。 |
|
| accountGroupType |
string |
リソースディレクトリでアカウントを選択するモード。 有効な値: all および custom。 |
all,custom |
| members |
array |
メンバーアカウントのリスト。 このパラメーターは、accountGroupType が custom に設定されている場合にのみ返されます。 |
|
|
string |
Alibaba Cloud アカウントの ID。 |
165***********50 |
|
| dataConfig |
object |
sls などのグローバルログタイプの構成。 このパラメーターは、他のログタイプでは空です。 |
|
| dataRegion |
string |
グローバルログが最初に収集されるリージョン。 このパラメーターは、sls などのグローバルログタイプにのみ使用されます。 |
cn-hangzhou |
| dataProject |
string |
グローバルログのプロジェクト。 このパラメーターは、sls などのグローバルログタイプにのみ使用されます。 このパラメーターが空の場合、ログは dataRegion で指定されたリージョンのアカウントのデフォルトプロジェクトに収集されます。 |
"" |
| internalPolicy |
boolean |
ポリシーが組み込みポリシーであるかどうかを示します。 組み込みポリシーは変更または削除できません。 |
false |
| policyUid |
string |
収集ルールを所有する Alibaba Cloud アカウントの ID。 リソースディレクトリ管理者または委任された管理者がルールを作成する場合、これはその管理者アカウントの ID です。 |
148***********50 |
| statistics |
array<object> |
クエリ条件に基づいて返される統計。 |
|
|
object |
productCode でグループ化された収集ルールの統計。 |
||
| productCode |
string |
Alibaba Cloud サービスのコード。 |
oss |
| policySourceList |
array<object> |
収集ルールソースのリスト。 |
|
|
object |
収集ルールのソース。 |
||
| policyUid |
string |
収集ルールを所有する Alibaba Cloud アカウントの ID。 リソースディレクトリ管理者または委任された管理者がルールを作成する場合、これはその管理者アカウントの ID です。 |
148***********50 |
| policyName |
string |
収集ルールの名前。 |
policy_name1_from148 |
例
成功レスポンス
JSONJSON
{
"totalCount": 1,
"currentCount": 1,
"data": [
{
"productCode": "oss",
"dataCode": "access_log",
"policyName": "your_log_policy",
"enabled": true,
"policyConfig": {
"resourceMode": "all",
"regions": [
"cn-hangzhou"
],
"instanceIds": [
"your-test-bucket1\n"
],
"resourceTags": {
"tag1": "value1",
"tag2": "value2"
}
},
"centralizeEnabled": false,
"centralizeConfig": {
"destRegion": "cn-beijing\n",
"destProject": "your-sls-project-in-beijing\n",
"destLogstore": "your-sls-logstore-in-beijing\n",
"destTTL": 0
},
"resourceDirectory": {
"accountGroupType": "all,custom",
"members": [
"165***********50"
]
},
"dataConfig": {
"dataRegion": "cn-hangzhou",
"dataProject": "\"\""
},
"internalPolicy": false,
"policyUid": "148***********50"
}
],
"statistics": [
{
"productCode": "oss",
"policySourceList": [
{
"policyUid": "148***********50",
"policyName": "policy_name1_from148"
}
]
}
]
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。