本文へジャンプします。

ニフクラ ユーザーガイド

クラウド トップ>API> RDB> CreateDBSecurityGroup
本ページは2023/9/5をもって、新ページhttps://docs.nifcloud.com/rdb/api/CreateDBSecurityGroup.htmへ移行しました。 今後は新ページをご参照ください。

CreateDBSecurityGroup

処理概要

DBファイアウォールグループを作成します。

指定するパラメーター

パラメーター 説明 必須
DBSecurityGroupDescription string

DBファイアウォールグループの説明

  • ※最大255字の印字可能文字が使用できます
  • ※空文字列を指定することも可能です
  • ※4バイト文字(絵文字や一部の漢字など)は使用できません

DBSecurityGroupName string

DBファイアウォールグループ名

  • ※1〜255字のアルファベット(小文字)・数字・ハイフン(‘-’)・アンダースコア(’_‘)・スペース(’ ’)が使用できます
  • ※最初の文字はアルファベットである必要があります
  • ※既に存在するDBファイアウォールグループの名前は指定できません
  • 例:mydbsecuritygroup

NiftyAvailabilityZone string

指定可能なゾーンについては、ニフクラ ゾーン別機能対応表をご参照ください。


備考: ニフクラ独自仕様

応答フィールド

フィールド (項目) 説明
CreateDBSecurityGroupResponse structure ルート
CreateDBSecurityGroupResult structure 結果
DBSecurityGroup structure DBファイアウォールグループ情報
備考: DBSecurityGroupの子要素はDescribeDBSecurityGroupsで返却される要素をすべて記載しているためAPIによっては返却されない要素もあります。実際のレスポンスはレスポンスサンプルを参照してください。
DBSecurityGroupDescription string DBファイアウォールグループの説明
DBSecurityGroupName string DBファイアウォールグループ名
EC2SecurityGroups list ニフクラのファイアウォールグループ要素リスト
EC2SecurityGroup structure ニフクラのファイアウォールグループ要素
EC2SecurityGroupName string ニフクラのファイアウォールグループ名
EC2SecurityGroupOwnerId string ニフクラのファイアウォールグループを所有している ニフクラID
Status string

ニフクラのファイアウォールグループのステータス

  • 値:authorized(有効)|authorizing(追加中)|revoking(削除中)|auth-failed(追加エラー)|revoke-failed(削除エラー)|not-exists(追加エラー(グループが存在しません))

IPRanges list IP帯リスト
IPRange structure IP帯
CIDRIP string CIDR
Status string

IP帯のステータス

値:authorized(有効)|authorizing(追加中)|revoking(削除中)|auth-failed(追加エラー)|revoke-failed(削除エラー)|not-exists(追加エラー(グループが存在しません))


OwnerId string DB ファイアウォールグループを所有している ニフクラID
NiftyAvailabilityZone string DB ファイアウォールグループのゾーン
備考: ニフクラ独自仕様
ResponseMetadata structure 共通メタ情報
RequestId string リクエスト識別子

エラー

コード メッセージ タイプ HTTPステータスコード 説明
Client.InvalidParameterCannotSpecify.DBSecurityGroupName

DBSecurityGroupName must not contain leading or trailing spaces.

Sender 400 DBSecurityGroupNameの最初または最後にスペースを入力した場合
Client.InvalidParameterDuplicate.DBSecurityGroupName

A security group named sample-security already exists

Sender 400 すでに存在するDBSecurityGroupNameを指定した場合
DBSecurityGroupNameに"default."で始まる値を指定した場合
Client.InvalidParameterFormat.DBSecurityGroupName

DBSecurityGroupName can contain only lowercase ASCII letters and digits, spaces, underscores, and hyphens.

Sender 400 DBSecurityGroupNameに無効な値(ハイフンから始まる 等)を指定した場合
Client.InvalidParameterIllegalInput.AvailabilityZone

aaa is not a valid availability zone.

Sender 400 NiftyAvailabilityZoneに存在しないAvailabilityZoneを指定した場合
Client.InvalidParameterIllegalInput.DBSecurityGroupDescription

DBSecurityGroupDescription (4バイト文字) is not a valid parameter.

Sender 400 DBSecurityGroupDescriptionに4バイト文字を含む値を指定した場合
Client.InvalidParameterRequired.AvailabilityZone

NiftyAvailabilityZone is required

Sender 400 必須のNiftyAvailabilityZoneを指定しなかった場合
Client.InvalidParameterRequired.DBSecurityGroupDescription

DBSecurityGroupDescription is required

Sender 400 必須のDBSecurityGroupDescriptionを指定しなかった場合
Client.InvalidParameterRequired.DBSecurityGroupName

DBSecurityGroupName is required

Sender 400 必須のDBSecurityGroupNameを指定しなかった場合
Client.InvalidParameterTooLong.DBSecurityGroupDescription

DBSecurityGroupDescription can be no longer than 255 characters

Sender 400 DBSecurityGroupDescriptionに255文字を超える値を指定した場合
Client.InvalidParameterTooLong.DBSecurityGroupName

DBSecurityGroupName can be no longer than 255 characters

Sender 400 DBSecurityGroupNameに255文字を超える値を指定した場合
Client.LimitExceeded.NumberOfDBSecurityGroup

Request would result in user exceeding the allowed number of DB Security Groups.

Sender 400 作成できるDBファイアウォールグループの上限に達している場合

リクエストサンプル

    https://jp-east-1.rdb.api.nifcloud.com/
  ?Action=CreateDBSecurityGroup
  &DBSecurityGroupName=mydbsecuritygroup
  &DBSecurityGroupDescription=My new db security group
  &NiftyAvailabilityZone=east-13
  &SignatureVersion=2
  &SignatureMethod=HmacSHA256
  &Timestamp=2013-12-09T00:00:00.000Z
  &AWSAccessKeyId=<NIFCLOUD Access Key ID>
  &Signature=<Signature>

  

応答サンプル

    <CreateDBSecurityGroupResponse>
  <CreateDBSecurityGroupResult>
    <DBSecurityGroup>
      <DBSecurityGroupDescription>My new db security group</DBSecurityGroupDescription>
      <DBSecurityGroupName>mydbsecuritygroup</DBSecurityGroupName>
      <EC2SecurityGroups/>
      <IPRanges/>
      <OwnerId>abc01234</OwnerId>
      <NiftyAvailabilityZone>east-13</NiftyAvailabilityZone>
    </DBSecurityGroup>
  </CreateDBSecurityGroupResult>
  <ResponseMetadata>
    <RequestId>4463042b-7384-4075-a1b0-c1deefb030e6</RequestId>
  </ResponseMetadata>
</CreateDBSecurityGroupResponse>

  
  • ※本ページ記載の金額は、すべて税抜表示です。
  • ※本ページ記載の他社製品名および会社名などは、各社の商標または登録商標です。
  • ※本ページの内容は、2023年9月05日時点の情報です。

推奨画面サイズ 1024×768 以上