rdb / Client / modify_db_instance
modify_db_instance
- rdb.Client.modify_db_instance(**kwargs)
DBサーバーの設定を変更します。
一度に複数のDB設定を変更することができます。
一部のパラメーターは、ApplyImmediatelyをfalseに指定しても「今すぐ」適用されることにご注意ください。
また、設定変更内容によってはIO性能低下・DBサーバー停止・DBサービス停止を伴うことがあります。
詳しくはユーザガイドとRDB技術仕様/制限値を参照してください。
See also: NIFCLOUD API Documentation
Request Syntax
response = client.modify_db_instance( AccountingType='1'|'2', AllocatedStorage=123, AllowMajorVersionUpgrade=True|False, ApplyImmediately=True|False, AutoMinorVersionUpgrade=True|False, BackupRetentionPeriod=123, BinlogRetentionPeriod=123, CACertificateIdentifier='string', CustomBinlogRetentionPeriod=True|False, DBInstanceClass='db.mini'|'db.e-small'|'db.small'|'db.e-small2'|'db.small2'|'db.e-small4'|'db.small4'|'db.e-small8'|'db.small8'|'db.e-small16'|'db.small16'|'db.e-medium'|'db.medium'|'db.e-medium4'|'db.medium4'|'db.e-medium8'|'db.medium8'|'db.e-medium16'|'db.medium16'|'db.e-medium24'|'db.medium24'|'db.e-large'|'db.large'|'db.e-large8'|'db.large8'|'db.e-large16'|'db.large16'|'db.e-large24'|'db.large24'|'db.e-large32'|'db.large32'|'db.e-extra-large8'|'db.extra-large8'|'db.e-extra-large16'|'db.extra-large16'|'db.e-extra-large24'|'db.extra-large24'|'db.e-extra-large32'|'db.extra-large32'|'db.e-extra-large48'|'db.extra-large48'|'db.e-double-large16'|'db.double-large16'|'db.e-double-large24'|'db.double-large24'|'db.e-double-large32'|'db.double-large32'|'db.e-double-large48'|'db.double-large48'|'db.e-double-large64'|'db.double-large64'|'db.e-double-large96'|'db.double-large96'|'db.triple-large32'|'db.triple-large48'|'db.triple-large64'|'db.triple-large96'|'db.triple-large128'|'db.quad-large64'|'db.quad-large96'|'db.quad-large128'|'db.septa-large128', DBInstanceIdentifier='string', DBParameterGroupName='string', DBSecurityGroups=[ 'string', ], EngineVersion='string', Iops=123, MasterUserPassword='string', MultiAZ=True|False, NewDBInstanceIdentifier='string', NiftySlavePrivateAddress='string', OptionGroupName='string', PreferredBackupWindow='string', PreferredMaintenanceWindow='string', VpcSecurityGroupIds=[ 'string', ] )
- Parameters:
AccountingType (string) –
AllocatedStorage (integer) –
AllowMajorVersionUpgrade (boolean) –
ApplyImmediately (boolean) –
AutoMinorVersionUpgrade (boolean) –
BackupRetentionPeriod (integer) –
BinlogRetentionPeriod (integer) –
CACertificateIdentifier (string) –
CustomBinlogRetentionPeriod (boolean) –
DBInstanceClass (string) –
DBInstanceIdentifier (string) – [REQUIRED]
DBParameterGroupName (string) –
DBSecurityGroups (list) –
(string) –
EngineVersion (string) –
Iops (integer) –
MasterUserPassword (string) –
MultiAZ (boolean) –
NewDBInstanceIdentifier (string) –
NiftySlavePrivateAddress (string) –
OptionGroupName (string) –
PreferredBackupWindow (string) –
PreferredMaintenanceWindow (string) –
VpcSecurityGroupIds (list) –
(string) –
- Return type:
dict
- Returns:
Response Syntax
{ 'DBInstance': { 'AccountingType': 'string', 'AllocatedStorage': 123, 'AutoMinorVersionUpgrade': True|False, 'AvailabilityZone': 'string', 'BackupRetentionPeriod': 123, 'BinlogRetentionPeriod': 123, 'CACertificateIdentifier': 'string', 'DBInstanceClass': 'string', 'DBInstanceIdentifier': 'string', 'DBInstanceStatus': 'string', 'DBName': 'string', 'DBParameterGroups': [ { 'DBParameterGroupName': 'string', 'ParameterApplyStatus': 'string' }, ], 'DBSecurityGroups': [ { 'DBSecurityGroupName': 'string', 'Status': 'string' }, ], 'Endpoint': { 'Address': 'string', 'NiftyPrivateAddress': 'string', 'Port': 123 }, 'Engine': 'string', 'EngineVersion': 'string', 'ExternalReplicationInfo': { 'ExternalMasterAddress': 'string', 'ExternalReplicationMessage': 'string', 'ExternalReplicationStatus': 'string', 'ReplicationAddresses': [ 'string', ], 'ReplicationPrivateAddresses': [ 'string', ] }, 'InstanceCreateTime': datetime(2015, 1, 1), 'LatestRestorableTime': datetime(2015, 1, 1), 'LicenseModel': 'string', 'MasterUsername': 'string', 'MultiAZ': True|False, 'NextMonthAccountingType': 'string', 'NiftyMasterPrivateAddress': 'string', 'NiftyMultiAZType': 'string', 'NiftyNetworkId': 'string', 'NiftySlavePrivateAddress': 'string', 'NiftyStorageType': 123, 'OptionGroupMemberships': [ { 'OptionGroupName': 'string', 'Status': 'string' }, ], 'PendingModifiedValues': { 'AllocatedStorage': 123, 'BackupRetentionPeriod': 123, 'DBInstanceClass': 'string', 'DBInstanceIdentifier': 'string', 'EngineVersion': 'string', 'MasterUserPassword': 'string', 'MultiAZ': True|False, 'Port': 123 }, 'PreferredBackupWindow': 'string', 'PreferredMaintenanceWindow': 'string', 'PubliclyAccessible': True|False, 'ReadReplicaDBInstanceIdentifiers': [ 'string', ], 'ReadReplicaSourceDBInstanceIdentifier': 'string', 'SecondaryAvailabilityZone': 'string', 'StatusInfos': [ { 'Message': 'string', 'Normal': True|False, 'Status': 'string', 'StatusType': 'string' }, ], 'VpcSecurityGroups': 'string' }, 'ResponseMetadata': { 'RequestId': 'string' } }
Response Structure
(dict) –
DBInstance (dict) –
AccountingType (string) –
AllocatedStorage (integer) –
AutoMinorVersionUpgrade (boolean) –
AvailabilityZone (string) –
BackupRetentionPeriod (integer) –
BinlogRetentionPeriod (integer) –
CACertificateIdentifier (string) –
DBInstanceClass (string) –
DBInstanceIdentifier (string) –
DBInstanceStatus (string) –
DBName (string) –
DBParameterGroups (list) –
(dict) –
DBParameterGroupName (string) –
ParameterApplyStatus (string) –
DBSecurityGroups (list) –
(dict) –
DBSecurityGroupName (string) –
Status (string) –
Endpoint (dict) –
Address (string) –
NiftyPrivateAddress (string) –
Port (integer) –
Engine (string) –
EngineVersion (string) –
ExternalReplicationInfo (dict) –
ExternalMasterAddress (string) –
ExternalReplicationMessage (string) –
ExternalReplicationStatus (string) –
ReplicationAddresses (list) –
(string) –
ReplicationPrivateAddresses (list) –
(string) –
InstanceCreateTime (datetime) –
LatestRestorableTime (datetime) –
LicenseModel (string) –
MasterUsername (string) –
MultiAZ (boolean) –
NextMonthAccountingType (string) –
NiftyMasterPrivateAddress (string) –
NiftyMultiAZType (string) –
NiftyNetworkId (string) –
NiftySlavePrivateAddress (string) –
NiftyStorageType (integer) –
OptionGroupMemberships (list) –
(dict) –
OptionGroupName (string) –
Status (string) –
PendingModifiedValues (dict) –
AllocatedStorage (integer) –
BackupRetentionPeriod (integer) –
DBInstanceClass (string) –
DBInstanceIdentifier (string) –
EngineVersion (string) –
MasterUserPassword (string) –
MultiAZ (boolean) –
Port (integer) –
PreferredBackupWindow (string) –
PreferredMaintenanceWindow (string) –
PubliclyAccessible (boolean) –
ReadReplicaDBInstanceIdentifiers (list) –
(string) –
ReadReplicaSourceDBInstanceIdentifier (string) –
SecondaryAvailabilityZone (string) –
StatusInfos (list) –
(dict) –
Message (string) –
Normal (boolean) –
Status (string) –
StatusType (string) –
VpcSecurityGroups (string) –
ResponseMetadata (dict) –
RequestId (string) –