addServerImageSharingPermission

VPC環境で利用できます。

サーバイメージの共有権限を追加します。サーバイメージを他のアカウントと共有して、サーバを効率的に運用・管理できます。

リクエスト

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

メソッド	URI
GET \| POST	/vserver/v2/addServerImageSharingPermission

参考

ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`regionCode`	String	Optional	リージョンコード getRegionListを参照照会結果の最初のリージョン(デフォルト)
`serverImageNo`	String	Required	サーバイメージ番号 getServerImageListを参照
`targetLoginIdList.N`	Array	Required	NAVERクラウドプラットフォームのアカウントログイン IDリストサーバイメージ共有対象を指定 <例> `targetLoginIdList.1=id1@email.com&targetLoginIdList.2=id2@naver.com`
`responseFormatType`	String	Optional	レスポンスデータの形式 `xml`(デフォルト) \| `json`

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vserver/v2/addServerImageSharingPermission
?serverImageNo=***3135
&targetLoginIdList.1=test-***@naver.com
&responseFormatType=json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`addServerImageSharingPermissionResponse`	Object	-	レスポンス結果 ServerImageListを参照
`addServerImageSharingPermissionResponse.requestId`	String	-	リクエスト ID UUID形式
`addServerImageSharingPermissionResponse.returnCode`	String	-	レスポンスコード
`addServerImageSharingPermissionResponse.returnMessage`	String	-	レスポンスメッセージ

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

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

レスポンス例

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

{
    "addServerImageSharingPermissionResponse": {
        "totalRows": 1,
        "serverImageList": [
            {
                "serverImageNo": "*****3135",
                "serverImageName": "test-***",
                "serverImageType": {
                    "code": "SELF",
                    "codeName": "SELFサーバイメージ"
                },
                "serverImageLifeCyclePhase": {
                    "code": "IN_SERVICE",
                    "codeName": "In Service"
                },
                "hypervisorType": {
                    "code": "KVM",
                    "codeName": "KVM"
                },
                "cpuArchitectureType": {
                    "code": "X86_64",
                    "codeName": "x86 64bit"
                },
                "osCategoryType": {
                    "code": "LINUX",
                    "codeName": "LINUX"
                },
                "osType": {
                    "code": "UBUNTU",
                    "codeName": "UBUNTU"
                },
                "serverImageStatus": {
                    "code": "CREAT",
                    "codeName": "NSI CREATED state"
                },
                "serverImageOperation": {
                    "code": "NULL",
                    "codeName": "NSI NULL OP"
                },
                "serverImageStatusName": "created",
                "shareStatus": {
                    "code": "SHARE",
                    "codeName": "NSI Share SHARE State"
                },
                "blockStorageMappingList": [
                    {
                        "order": 0,
                        "blockStorageSnapshotInstanceNo": *****4697,
                        "blockStorageSnapshotName": "test-***",
                        "blockStorageSize": 10737418240,
                        "blockStorageVolumeType": {
                            "code": "CB1",
                            "codeName": "Common BlockStorage 1"
                        },
                        "iops": 100,
                        "throughput": 104857600,
                        "isEncryptedVolume": false
                    }
                ],
                "sharedLoginIdList": [
                    "test-***@naver.com"
                ],
                "serverImageProductCode": "SW.VSVR.OS.LNX64.UBNTU.SVR24.G003",
                "createDate": "2025-06-20T09:59:39+0900",
                "platformCategoryCode": "OS"
            }
        ],
        "requestId": "d4fcece2-935a-4c91-bf35-54347eb900ad",
        "returnCode": "0",
        "returnMessage": "success"
    }
}