addNasVolumeAccessControl

VPC環境で利用できます。

サーバインスタンス番号を利用して NASボリュームインスタンスにアクセス制御を追加します。

参考

設定されたアクセス制御ルールは、getNasVolumeAccessControlRuleListアクションを通じて確認できます。

リクエスト

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

メソッド	URI
GET, POST	/addNasVolumeAccessControl

リクエストヘッダ

NAS APIで共通して使用されるヘッダの詳細は、NASの共通ヘッダをご参照ください。

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

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

フィールド	タイプ	必須の有無	説明
`regionCode`	String	Optional	アクセス制御を追加する NASボリュームインスタンスのリージョンコード getRegionListアクションを通じて確認可能(デフォルト: `KR`)
`nasVolumeInstanceNo`	String	Required	アクセス制御を追加する NASボリュームインスタンス番号 getNasVolumeInstanceListアクションを通じて確認ボリューム割り当てプロトコルのタイプが NFSの NASボリュームインスタンスのみアクセス制御を設定可能
`accessControlRuleList.N.serverInstanceNo`	String	Required	アクセス制御に追加するサーバインスタンス番号 getServerInstanceListアクションを通じて確認
`accessControlRuleList.N.writeAccess`	Boolean	Optional	書き込み権限 `true` (デフォルト) \| `false` `true`: 設定 `false`: 設定しない
`responseFormatType`	String	Optional	レスポンス結果の形式タイプ `xml`(デフォルト) \| `json`

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vnas/v2/addNasVolumeAccessControl?nasVolumeInstanceNo=23380000&accessControlRuleList.1.serverInstanceNo=23320000&regionCode=KR&accessControlRuleList.1.writeAccess=true&responseFormatType=json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Sub Account Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

レスポンスボディの詳細は、NasVolumeInstanceListをご参照ください。

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

NAVERクラウドプラットフォームでで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

レスポンス例

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

{
    "addNasVolumeAccessControlResponse": {
        "totalRows": 1,
        "nasVolumeInstanceList": [
            {
                "nasVolumeInstanceNo": "23380000",
                "nasVolumeInstanceStatus": {
                    "code": "CREAT",
                    "codeName": "NAS create"
                },
                "nasVolumeInstanceOperation": {
                    "code": "NULL",
                    "codeName": "NAS NULL OP"
                },
                "nasVolumeInstanceStatusName": "created",
                "createDate": "2024-04-02T10:06:29+0900",
                "nasVolumeDescription": "",
                "mountInformation": "169.254.00.00:/n2768364_vn18e9c000000",
                "volumeAllotmentProtocolType": {
                    "code": "NFS",
                    "codeName": "NFS"
                },
                "volumeName": "n2768364_vn18e9c000000",
                "volumeTotalSize": 644245094400,
                "volumeSize": 644245094400,
                "snapshotVolumeConfigurationRatio": 0.0,
                "snapshotVolumeSize": 0,
                "isSnapshotConfiguration": false,
                "isEventConfiguration": false,
                "regionCode": "KR",
                "zoneCode": "KR-2",
                "nasVolumeServerInstanceNoList": [
                    "23320000"
                ],
                "isEncryptedVolume": false,
                "nasVolumeInstanceCustomIpList": [],
                "isReturnProtection": false
            }
        ],
        "requestId": "",
        "returnCode": "0",
        "returnMessage": "success"
    }
}