フローログを照会します。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須/任意 説明
操作 String 必須 DescribeFlowlogs

実行する操作です。 値をDescribeFlowLogsに設定します。

ClientToken String 任意 123e4567-e89b-12d3-a456-42665544 ****

リクエストのべき等性を保証するために使用されるクライアントトークン。

クライアントを使用して値を生成できますが、すべてのリクエスト間で一意であることを確認する必要があります。 トークンにはASCII文字のみを含めることができます。

説明 このパラメーターを設定しない場合、ClientTokenはRequestIdの値に設定されます。 RequestIdの値は、APIリクエストごとに異なる場合があります。
RegionId String 任意 cn-hangzhou

フローログがデプロイされているリージョンのID。

DescribeChildInstanceRegionsを呼び出して、最新のリージョンリストを照会できます。

FlowLogName String 任意 myFlowlog

フローログの名前。

名前は2 ~ 128文字で、数字、ピリオド (.) 、アンダースコア (_) 、ハイフン (-) を使用できます。 名前は文字で始める必要がありますが、http:// またはhttps:// で始めることはできません。

FlowLogId String 任意 flowlog-m5evbtbpt****

フローログの ID。

説明 String 任意 myFlowlog

フローログの説明。

説明の長さは 2~256 文字である必要があります。 名前は英字で始まる必要があります。先頭文字列は http:// または https:// にすることはできません。

CenId String 任意 cen-7qthudw0ll6jmc****

Cloud Enterprise Network (CEN) インスタンスのID。

ProjectName String 任意 FlowLogProject

フローログが保存されているプロジェクトの名前。

名前は3 ~ 63文字で、英小文字、数字、ハイフン (-) を使用できます。 先頭または末尾は小文字または数字である必要があります。

LogStoreName String 任意 FlowLogStore

フローログが保存されているLogstoreの名前。

名前は3 ~ 63文字で、英小文字、数字、アンダースコア (_) 、およびハイフン (-) を使用できます。 先頭または末尾は小文字または数字である必要があります。

Status String 任意 Active

フローログのステータス。 設定可能な値は以下のとおりです。

  • アクティブ: フローログが有効になっています。
  • Inactive: フローログは無効です。
PageNumber Integer 任意 1

返されるページ数。 既定値:1

PageSize Integer 任意 20

各ページで返されるエントリ数。 最小値: 1。 デフォルト値: 20

レスポンスパラメーター

パラメーター データ型 説明
PageSize String 20

1 ページあたりで返されるエントリ数。

PageNumber String 1

返されたページの数を示します。

RequestId String F7DDDC17-FA06-4AC2-8F35-59D2470FCFC1

リクエストの ID です。

TotalCount String 1

返されたエントリの数。

Success String 真実

呼び出しが成功したかどうかを示します。

  • true: はい
  • false: いいえ
FlowLogs FlowLogの配列

フローログに関する情報。

FlowLog
Status String Active

フローログのステータス。

  • Active: フローログが有効になります。
  • Inactive: フローログは無効です。
CreationTime String 2021-07-24T13:00:52Z

フローログが作成された時刻。

時間は、YYYY-MM-DDThh:mm:ssZ形式のISO 8601標準に従います。 時刻は UTC で表示されます。

FlowLogName String myFlowlog

フローログの名前。

説明 String myFlowlog

フローログの説明。

ProjectName String FlowLogProject

フローログが保存されているプロジェクトの名前。

CenId String cen-7qthudw0ll6jmc****

CEN インスタンスの ID。

LogStoreName String FlowLogStore

フローログが保存されているLogstoreの名前。

RegionId String cn-hangzhou

フローログがデプロイされているリージョンのID。

FlowLogId String flowlog-m5evbtbpt****

フローログの ID。

リクエストの例

http(s)://[Endpoint]/?Action=DescribeFlowlogs
&ClientToken=123e4567-e89b-12d3-a456-42665544 ****
&RegionId=cn-hangzhou
&FlowLogName=myFlowlog
&FlowLogId=flowlog-m5evbtbpt ****
&Description=myFlowlog
&CenId=cen-7qthudw0ll6jmc ****
&ProjectName=FlowLogProject
&LogStoreName=FlowLogStore
&ステータス=アクティブ
&PageNumber=1
&PageSize=20
&共通リクエストパラメータ

正常に処理された場合のレスポンス例

XML 形式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeFlowlogsResponse>
    <PageSize>20</PageSize>
    <ページ番号> 1 </ PAGENUMBER>
    <RequestId>F7DDDC17-FA06-4AC2-8F35-59D2470FCFC1</RequestId>
    <TotalCount> 1 </ TotalCount>
    <成功> true </成功>
    <フローログ>
        <Status>Active</Status>
        <CreationTime>2021-07-24T13:00:52Z</CreationTime>
        <FlowLogName>myFlowlog</FlowLogName>
        <説明> myFlowlog</説明>
        <ProjectName>FlowLogProject</ProjectName>
        <CenId>cen-7qthudw0ll6jmc ****</CenId>
        <LogStoreName>FlowLogStore</LogStoreName>
        <RegionId>cn-hangzhou</RegionId>
        <FlowLogId>flowlog-m5evbtbpt ****</FlowLogId>
    </フローログ>
</DescribeFlowlogsResponse>

JSON 形式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "PageSize" : "20" 、
  "PageNumber" : "1" 、
  "RequestId" : "F7DDDC17-FA06-4AC2-8F35-59D2470FCFC1" 、
  "TotalCount" : "1" 、
  "成功" : "真" 、
  "FlowLogs" : [ {
    "ステータス" : "アクティブ" 、
    "CreationTime" : "2021-07-24T13:00:52Z" 、
    "FlowLogName" : "myFlowlog" 、
    "説明" : "myFlowlog" 、
    "ProjectName" : "FlowLogProject" 、
    "CenId" : "cen-7qthudw0ll6jmc ****" 、
    "LogStoreName" : "FlowLogStore" 、
    "RegionId" : "cn-hangzhou" 、
    "FlowLogId" : "flowlog-m5evbtbpt ****"
  } ]
}

エラーコード

エラーコードリストについては、「API エラーセンター」をご参照ください。