ModifyBackupSourceEndpoint - Data Management - Centro de documentación de Alibaba Cloud

Modifica un endpoint de origen de respaldo de DBS.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

dbs:ModifyBackupSourceEndpoint

update

*BackupPlan

acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
BackupPlanId	string	Sí	El ID del plan de respaldo. Puede llamar a la operación DescribeBackupPlanList para obtener este valor.	dbs1h****usfa
SourceEndpointInstanceType	string	Sí	El tipo de la instancia de origen. Puede llamar a la operación DescribeBackupPlanList para obtener este valor. Valores válidos: RDS: una instancia de RDS ECS: una base de datos autogestionada en una instancia de ECS Express: una base de datos conectada mediante una línea arrendada, VPN Gateway o Smart Access Gateway Agent: una base de datos conectada mediante una puerta de enlace de respaldo DDS: una instancia de ApsaraDB for MongoDB Other: una base de datos conectada mediante una dirección IP y un puerto	RDS
SourceEndpointRegion	string	No	La región de la base de datos. Puede llamar a la operación DescribeBackupPlanList para obtener este valor. Nota Este parámetro es obligatorio si el parámetro SourceEndpointInstanceType está configurado como `RDS`, `ECS`, `DDS`, `Express` o `Agent`.	cn-hangzhou
SourceEndpointInstanceID	string	No	El ID de la instancia de base de datos. Puede llamar a la operación DescribeBackupPlanList para obtener este valor. Nota Este parámetro es obligatorio si el parámetro SourceEndpointInstanceType está configurado como `RDS`, `ECS`, `DDS` o `Express`.	rm-bp1p8c29479jv****
SourceEndpointIP	string	No	La dirección IP de la base de datos. Puede llamar a la operación DescribeBackupPlanList para obtener este valor. Nota Este parámetro es obligatorio si el parámetro SourceEndpointInstanceType está configurado como `Express`, `Agent` u `Other`.	100...10:3306
SourceEndpointPort	integer	No	El puerto de la base de datos. Puede llamar a la operación DescribeBackupPlanList para obtener este valor. Nota Este parámetro es obligatorio si el parámetro SourceEndpointInstanceType está configurado como `Express`, `Agent`, `Other` o `ECS`.	3306
SourceEndpointDatabaseName	string	No	El nombre de la base de datos. Este parámetro es obligatorio para bases de datos PostgreSQL y MongoDB. Este parámetro también es obligatorio para bases de datos Microsoft SQL Server cuando el parámetro SourceEndpointInstanceType está configurado como 'Agent'.	test
SourceEndpointUserName	string	No	El nombre de usuario de la cuenta de la base de datos. Puede llamar a la operación DescribeBackupPlanList para obtener este valor. Este parámetro es obligatorio para todos los motores de base de datos, excepto para Redis y Microsoft SQL Server (cuando el parámetro SourceEndpointInstanceType está configurado como 'Agent').	test
SourceEndpointPassword	string	No	La contraseña de la cuenta de la base de datos. Este parámetro es obligatorio para todos los motores de base de datos, excepto para Redis y Microsoft SQL Server (cuando el parámetro SourceEndpointInstanceType está configurado como 'Agent').	test
BackupGatewayId	integer	No	El ID de la puerta de enlace de respaldo. Puede llamar a la operación DescribeBackupPlanList para obtener este valor. Nota Este parámetro es obligatorio si el parámetro SourceEndpointInstanceType está configurado como `Agent`.	21321323213
BackupObjects	string	No	Objetos de respaldo: este parámetro es opcional si la base de datos se encuentra en un agente, pero es obligatorio en todos los demás escenarios. Puede llamar a la operación DescribeBackupPlanList para obtener el valor de este parámetro.	[{ "DBName":"待备份库名", "SchemaName":"待备份 Schema 名", "TableIncludes":[{ "TableName":"待备份表表名" }], "TableExcludes":[{"TableName":"待备份库名不需要备份表的表名" }] } ]
SourceEndpointOracleSID	string	No	El SID de Oracle. Este parámetro es obligatorio para bases de datos Oracle.	test
CrossAliyunId	string	No	El UID para el respaldo entre cuentas.	2xxx7778xxxxxxxxxx
CrossRoleName	string	No	El nombre del rol de RAM para el respaldo entre cuentas.	test123
ClientToken	string	No	Un token generado por el cliente para garantizar la idempotencia de la solicitud.	ETnLKlblzczshOTUbOCzxxxxxxx
EnableSourceEndpointSsl	string	No	Especifica si se debe usar una conexión SSL para respaldar la base de datos de origen.	true
SslCaPem	string	No	El certificado PEM para la conexión SSL.	-----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----
SourceEndpointOracleHome	string	No	La ruta de Oracle Home.	/home/test

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
HttpStatusCode	integer	El código de estado HTTP.	200
RequestId	string	El ID de la solicitud.	D6E068C3-25BC-455A-85FE-45F0B22E****
ErrCode	string	El código de error.	Param.NotFound
Success	boolean	Indica si la solicitud se realizó correctamente. Valores válidos: true: la solicitud se realizó correctamente. false: la solicitud falló.	true
ErrMessage	string	El mensaje de error.	The specified parameter %s value is not valid
BackupPlanId	string	El ID del plan de respaldo.	dbs1h****usfa
NeedPrecheck	boolean	Indica si la modificación activa una verificación previa. Si este parámetro está configurado como true, debe llamar a la operación StartBackupPlan para iniciar el plan de respaldo.	false

Ejemplos

Respuesta exitosa

JSON Formato

{
  "HttpStatusCode": 200,
  "RequestId": "D6E068C3-25BC-455A-85FE-45F0B22E****",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid. ",
  "BackupPlanId": "dbs1h****usfa",
  "NeedPrecheck": false
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
403	Request.Forbidden	Have no Permissions

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.