すべてのプロジェクトのリストを照会します。
例
GET /? offset={offset}&size={size}
リクエスト構文
GET /? offset={offset}&size={size} HTTP/1.1
Authorization: <AuthorizationString>
x-log-bodyrawsize: 0
User-Agent: <UserAgent>
x-log-apiversion: 0.6.0
Host: <Endpoint>
x-log-signaturemethod: hmac-sha1
Date: <GMT Date>
Content-Type: application/x-protobuf
Connection: Keep-Alive
リクエストパラメータ
属性名 | データ型 | 必須 | 説明 |
---|---|---|---|
offset | integer | 省略可能 | 返すレコードの開始位置。 デフォルト値は 0 です。 |
size | integer | 省略可能 | 返すエントリの 1 ページあたりの最大数です。 デフォルト値は 500 です (最大値)。 |
ListProject インターフェースには固有のリクエストヘッダーはありません。 Log Service API のパブリックリクエストヘッダーの詳細については、「パブリックリクエストヘッダー」をご参照ください。
レスポンスヘッダーListProject インターフェースには固有のリクエストヘッダーはありません。 Log Service API のパブリックレスポンスヘッダーの詳細については、「パブリックレスポンスヘッダー」をご参照ください。
レスポンス要素ListProject リクエストが正常に送信されると、レスポンスボディの指定したプロジェクトと Logstore の中にすべてのコンシューマーグループが以下の形式で含まれます。
属性名 | データ型 | 説明 |
---|---|---|
count | integer | 返すプロジェクト数 |
total | integer | プロセスの総数 |
projects | array | プロジェクトリスト |
プロジェクトの各要素は以下の形式で表されます。
属性名 | データ型 | 説明 |
---|---|---|
createTime | string | 作成j時間 |
説明 | string | プロジェクトの説明 |
lastModifyTime | string | 最終更新時間 |
owner | string | プロジェクト作成者のアカウント ID |
projectName | string | プロジェクト名 |
status | string | プロジェクトステータス |
region | string | 除外されるフィールドのリスト |
Log Service API 一般的なエラー コード に加えて、インターフェースから以下のエラーコードが返される場合があります。
HTTP ステータスコード | エラーコード | エラーメッセージ |
---|---|---|
500 | InternalServerError | Specified Server Error Message. |
例
リクエスト例
GET /? offset=0&size=2&projectName= HTTP/1.1
Authorization: LOG <yourAccessKeyId>:<yourSignature>
x-log-bodyrawsize: 0
User-Agent: sls-java-sdk-v-0.6.1
x-log-apiversion: 0.6.0
Host: cn-shanghai.log.aliyuncs.com
x-log-signaturemethod: hmac-sha1
Date: Sun, 27 May 2018 09:03:33 GMT
Content-Type: application/x-protobuf
Connection: Keep-Alive
レスポンス例:
HTTP/1.1 200
Server: nginx
Content-Type: application/json
Content-Length: 345
Connection: close
Access-Control-Allow-Origin: *
Date: Sun, 27 May 2018 09:03:33 GMT
x-log-requestid: 5B0A7465AAEA20CA70DE3064
{
"count": 2,
"total": 11,
"projects": [
{
"projectName": "project1",
"status": "Normal",
"owner": "",
"description": "",
"region": "cn-shanghai",
"createTime": "1524222931",
"lastModifyTime": "1524539357"
},
{
"projectName": "project123456",
"status": "Normal",
"owner": "",
"description": "",
"region": "cn-shanghai",
"createTime": "1471963876",
"lastModifyTime": "1524539357"
}
]
}