ワークスペースの詳細照会

VPC環境で利用できます。

ワークスペースの詳細情報を照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET	/api/v1/workspaces/{workspace_name}

リクエストヘッダ

Media Intelligence APIで共通して使用されるヘッダの詳細は、Media Intelligenceのリクエストヘッダをご参照ください。

リクエストパスパラメータ

パラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`workspace_name`	String	Required	ワークスペース名

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://mi.apigw.ntruss.com/api/v1/workspaces/my-workspace' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`code`	String	-	API処理結果コード
`message`	String	-	API処理結果メッセージ
`result`	Object	-	ワークスペースの詳細情報
`result.workspaceName`	String	-	ワークスペース名
`result.workspaceUrl`	String	-	ワークスペース URL
`result.bucketName`	String	-	連携された Object Storageバケット名
`result.monthlyAnalysisCount`	Integer	-	月間分析件数
`result.createdUserName`	String	-	作成者名
`result.createdTime`	String	-	作成日時 ISO 8601形式
`result.updatedUserName`	String	-	更新者名
`result.updatedTime`	String	-	更新日時 ISO 8601形式

レスポンスステータスコード

Media Intelligence APIで共通して使用されるレスポンスステータスコードの詳細は、Media Intelligenceのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "code": "0",
    "message": "success",
    "result": {
        "workspaceName": "my-workspace",
        "workspaceUrl": "https://mi.apigw.ntruss.com/api/v1/workspaces/my-workspace",
        "bucketName": "my-bucket",
        "monthlyAnalysisCount": 150,
        "createdUserName": "username",
        "createdTime": "2026-03-18T10:30:00",
        "updatedUserName": "username",
        "updatedTime": "2026-03-18T10:30:00"
    }
}