サイトの照会

Classic/VPC環境で利用できます。

サイトの詳細情報を照会します。

リクエスト

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

メソッド	URI
GET	/api/v1/sites/{siteId}

リクエストヘッダ

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

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

リクエストパスパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`siteId`	String	Required	サイト ID サイトリストの照会を参照

リクエスト例

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

curl --location --request GET 'https://multi-drm.apigw.ntruss.com/api/v1/sites/drm-20250903141775-*****' \
--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' \
--header 'x-ncp-region_code: KR'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`success`	Boolean	-	API処理結果 `true` \| `false` `true`: 成功 `false`: 失敗
`content`	Object	-	サイトの詳細情報
`content.disabled`	Boolean	-	Sub Accountは無効化するか `true` \| `false` `true`: 無効化 `false`: 有効化
`content.siteId`	String	-	サイト ID
`content.siteName`	String	-	サイト名
`content.siteStatus`	String	-	サイトの状態 `CREATING` \| `READY` \| `RUNNING` \| `DELETED` `CREATING`: 作成中 `READY`: 使用可能 `RUNNING`: 使用中 `DELETED`: 削除完了
`content.siteEnabledYn`	Boolean	-	サイトを有効化するか `true` \| `false` `true`: 有効化 `false`: 無効化
`content.policyId`	Integer	-	DRMポリシー ID `0`: Basic
`content.policyName`	String	-	ポリシー名 `Basic` (デフォルト)
`content.kmsToken`	String	-	KMSトークン CPIX APIによるコンテンツパッケージ化キー連携に使用される認証トークンサイトごとに固有の値
`content.fairPlayCert`	Object	-	FairPlay Streaming認証情報
`content.fairPlayCert.certFile`	String	-	FPS証明書 Appleの開発者ポータルで作成された DERまたは CERファイル HTTP URLのみサポート
`content.fairPlayCert.privateKey`	String	-	秘密鍵 PEMファイル HTTP URLのみサポート
`content.fairPlayCert.privateEncryptedString`	String	-	秘密鍵ファイルを開くためのパスワード文字列
`content.fairPlayCert.secretKey`	String	-	Application secret key(ASK)文字列 FPS証明書の作成時に一緒に取得
`content.statistics`	Object	-	サイト統計情報
`content.statistics.siteMontlyActiveUser`	Integer	-	DRM適用コンテンツを利用した月間ユーザー数
`content.statistics.siteMontlyActiveLicense`	Integer	-	有効化された月間ライセンス数
`content.statistics.siteMontlyActiveDevice`	Integer	-	DRM適用コンテンツが再生された月間ユーザー数
`content.siteCreatedTime`	Integer	-	サイトの作成日時 Unix Timestamp形式
`content.siteUpdatedTime`	Integer	-	サイトの更新日時 Unix Timestamp形式

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

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

レスポンス例

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

{
    "success": true,
    "content": {
        "disabled": false,
        "siteId": "drm-20250903141775-*****",
        "siteName": "myDrmSite",
        "siteStatus": "READY",
        "siteEnabledYn": false,
        "policyId": 0,
        "policyName": "Basic",
        "kmsToken": "****************************************************************",
        "fairPlayCert": {
            "certFile": "myFairPlayCert.cer",
            "privateKey": "myFairPlayCertPrivateKey.pem",
            "privateEncryptedString": "************",
            "secretKey": "************"
        },
        "statistics": {
            "siteMontlyActiveUser": 0,
            "siteMontlyActiveDevice": 0,
            "siteMontlyActiveLicense": 0
        },
        "siteCreatedTime": 1756876670519,
        "siteUpdatedTime": 1756844777000
    }
}