マシングループ名の一覧を表示します。
例:
GET /machinegroups? offset=1&size=100
リクエスト構文
GET /machinegroups? offset=1&size=100 HTTP/1.1
Authorization: <AuthorizationString>
Date: <GMT Date>
Host: <Project Endpoint>
x-log-apiversion: 0.6.0
x-log-signaturemethod: hmac-sha1
リクエストパラメーター
URL パラメーター:
パラメータ名 | データ型 | 必須/省略可能 | 説明 |
---|---|---|---|
offset | int | 省略可能 | 返されたレコードの開始位置 (デフォルトは 0)。 |
size | int | 省略可能 | 各ページに返されるエントリの最大数です。 デフォルト値は 500 (最大値) です。 |
groupName | string | 省略可能 | フィルタリングに使用されるグループマシン名 (部分一致をサポート) |
ListMachineGroup API には特別なレスポンスヘッダーはありません。 Log Service API のパブリックリクエストヘッダーの詳細については、「パブリックリクエストヘッダー」をご参照ください。
レスポンスヘッダーListMachineGroup API には特別なレスポンスヘッダーはありません。 Log Service API のパブリックレスポンスヘッダーの詳細については、「パブリックレスポンスヘッダー」をご参照ください。
レスポンス要素リクエストが正常に実行されると、特定のプロジェクト内のすべてのマシン グループの一覧がレスポンスボディに含まれます。 具体的な形式は以下の通りです。 具体的な形式は以下の通りです。
名前 | データ型 | 説明 |
---|---|---|
count | int | 返されるマシングループの数 |
total | int | 返されるマシングループの合計。 |
machinegroups | json array | 返されるマシングループの名前一覧。 |
{
"machinegroups": [
"test-machine-group",
"test-machine-group-2"
],
"count": 2,
"total": 2
}
エラーコード
ログサービス API の一般的なエラーコードに加えて、 ListMachineGroup API から次の 特別なエラーコード が返される場合があります。
HTTP ステータスコード | エラーコード | エラーメッセージ |
---|---|---|
500 | InternalServerError | 内部サーバーエラー |
例
リクエスト例:
GET /machinegroups? groupName=test-machine-group&offset=0&size=3 HTTP/1.1
Header :
{
"x-log-apiversion": "0.6.0",
"Authorization": "LOG <yourAccessKeyId>:<yourSignature>",
"Host": "ali-test-project.cn-hangzhou-devcommon-intranet.sls.aliyuncs.com",
"Date": "Tue, 10 Nov 2015 18:41:43 GMT",
"Content-Length": "0",
"x-log-signaturemethod": "hmac-sha1",
"User-Agent": "sls-java-sdk-v-0.6.0",
"Content-Type": "application/x-protobuf",
"x-log-bodyrawsize": "0"
}
レスポンス例:
HTTP/1.1 200 OK
Header :
{
"Date": "Tue, 10 Nov 2015 18:34:44 GMT",
"Content-Length": "83",
"x-log-requestid": "564238C499248C8F7B0001DE",
"Connection": "close",
"Content-Type": "application/json",
"Server": "nginx/1.6.1"
}
Body :
{
"machinegroups": [
"test-machine-group",
"test-machine-group-2"
],
"count": 2,
"total": 2
}