Descripción general de la API - CloudOps Orchestration Service - Centro de documentación de Alibaba Cloud

Estándares de API y SDK preconfigurados multilenguaje

La OpenAPI de este producto (oos/2019-06-01) utiliza el estilo de firma RPC. Se han encapsulado SDK para los lenguajes de programación más comunes con el fin de facilitar el desarrollo. Los desarrolladores pueden descargar el SDK para invocar directamente la OpenAPI de este producto sin preocuparse por los detalles técnicos. Si el SDK existente no satisface sus necesidades, utilice el mecanismo de firma para una integración con autofirma. Dado que los detalles de la autofirma son muy complejos, este proceso puede tardar alrededor de 5 días hábiles. Por lo tanto, se recomienda unirse a nuestro grupo de servicio de DingTalk (147535001692) para llevar a cabo la integración de firmas bajo la guía de expertos.

Antes de usar la API, prepare su cuenta de identidad y su clave de acceso (AccessKey) para acceder eficazmente a la API mediante herramientas cliente (como SDK y CLI). Para obtener más información, consulte Obtener un AccessKey.

Escenarios de firma personalizada

Si su escenario empresarial tiene requisitos especiales y necesita integrar la API mediante autofirma, se recomienda consultar primero a nuestro equipo de soporte técnico (grupo de servicio de DingTalk: 147535001692) para obtener orientación profesional y garantizar una integración eficiente.

Preparación de cuenta y seguridad

Las cuentas de Alibaba Cloud tienen permisos administrativos completos sobre todos los recursos. Si un AccessKey se ve comprometido, todos los recursos asociados corren el riesgo de sufrir accesos no autorizados. Para garantizar la seguridad, se recomienda crear un RAM user con permisos de acceso exclusivos a la API y configurar su AccessKey, además de establecer directivas de RAM basadas en el principio de menor privilegio (PoLP). Utilice la cuenta de Alibaba Cloud únicamente en escenarios específicos donde se requieran explícitamente sus permisos.

Región

API	Título	Descripción
GetGitRepository	Consultar un repositorio de Git.	Consulta los detalles de un repositorio de Git.
DescribeRegions	Consultar regiones admitidas.	Consulta las regiones que se admiten actualmente.

Plantilla

API	Título	Descripción
CreateTemplate	Crear una plantilla.	Crea una plantilla.
DeleteTemplates	Eliminar varias plantillas.	Elimina varias plantillas.
DeleteTemplate	Eliminar una plantilla.	Elimina una plantilla.
UpdateTemplate	Actualizar una plantilla existente.	Actualiza una plantilla existente.
ListTemplateVersions	Consultar múltiples objetos de versión de una plantilla.	Consulta múltiples objetos de versión de una plantilla.
ListTemplates	Consultar plantillas.	Consulta plantillas. Admite múltiples métodos de filtrado.
GetTemplate	Obtener una plantilla.	Obtiene una plantilla, incluido su contenido.
ListExecutionRiskyTasks	Obtener tareas de alto riesgo en una plantilla.	Obtiene las tareas de alto riesgo en una plantilla.
ValidateTemplateContent	Validar si una plantilla es válida.	Valida si una plantilla es válida.
UpdateTemplateAttributes	Actualizar propiedades de la plantilla.	Actualiza las propiedades de la plantilla.
GetTemplateParameterConstraints	Obtener valores disponibles para los parámetros de la plantilla.	Obtiene los valores disponibles para los parámetros de la plantilla.

Ejecución

API	Título	Descripción
DeleteExecutions	Eliminar una ejecución.	Elimina una ejecución.
StartExecution	Iniciar una ejecución de tarea.	Inicia una ejecución de tarea.
UpdateExecution	Actualizar una ejecución no finalizada.	Actualiza una ejecución que no ha finalizado (en estado Running o Waiting).
GetExecutionTemplate	Obtener la plantilla utilizada por una ejecución de tarea.	Obtiene la plantilla utilizada por una ejecución de tarea, incluido su contenido.
ListExecutions	Consulta de ejecuciones de tareas.	Consulta las ejecuciones de tareas con compatibilidad para múltiples métodos de filtrado.
ListExecutionLogs	Obtener registros detallados de ejecución.	Obtiene los registros detallados de una ejecución.
ListTaskExecutions	Consultar ejecuciones de tareas.	Consulta las ejecuciones de tareas con compatibilidad para múltiples métodos de filtrado.
ListResourceExecutionStatus	Consulta de información de ejecución de O&M programada que incluye instancias de ECS.	Consulta la información de ejecución de O&M programada que incluye instancias de ECS.
CancelExecution	Cancelar una ejecución de tarea.	Cancela una ejecución de tarea.
GenerateExecutionPolicy	Obtener la política de RAM necesaria para la ejecución.	Obtiene la política de RAM necesaria para la ejecución de la plantilla.
NotifyExecution	Notify an execution how to proceed	Notifica a una ejecución en espera cómo proceder.
TriggerExecution	Activar ejecución de evento.	Envía un cuerpo de mensaje a una ejecución de tarea de activador de eventos, activador de alarmas o activador de temporizador, lo que provoca que la tarea de evento, alarma o temporizador cree una nueva ejecución secundaria.
StartDebugExecution	Ejecutar una tarea de prueba.	Inicia la ejecución de una tarea.
ListTaskExecutionInvocations	Obtener el ID de invocación de comando de Cloud Assistant dentro de una ejecución de tarea.	Obtiene el ID de invocación de comando de Cloud Assistant dentro de una ejecución de tarea.

Acción

API	Título	Descripción
ListActions	Consultar acciones disponibles.	Consulta las acciones disponibles, incluidas las acciones atómicas y las acciones de productos en la nube.

Parámetro

API	Título	Descripción
Parámetro común	Parámetro común
CreateParameter	Crear un parámetro común.	Crea un parámetro común.
DeleteParameter	Eliminar un parámetro común.	Elimina un parámetro común.
UpdateParameter	Actualizar un parámetro común existente.	Actualiza un parámetro común existente.
GetParameter	Obtener un parámetro común.	Obtiene un parámetro común o un parámetro público, incluido el valor del parámetro.
ListParameters	Parámetros de consulta.	Consulta parámetros y parámetros comunes. Se admiten múltiples métodos de consulta.
ListParameterVersions	Consultar múltiples objetos de versión de un parámetro común.	Consulta múltiples objetos de versión de un parámetro común.
GetParametersByPath	Obtener parámetros comunes por ruta.	Obtiene parámetros por ruta.
GetParameters	Obtener los detalles de uno o más parámetros comunes.	Obtiene los detalles de uno o más parámetros.
Parámetro cifrado	Parámetro cifrado
CreateSecretParameter	Crear un parámetro cifrado.	Crea un parámetro cifrado. Asegúrese de tener permiso para llamar a la operación de API CreateSecret de KMS antes de invocar esta operación.
DeleteSecretParameter	Eliminar un parámetro cifrado.	Elimina un parámetro cifrado. Asegúrese de tener permiso para llamar a la operación de API DeleteSecret de KMS antes de llamar a esta operación.
UpdateSecretParameter	Actualizar un parámetro de cifrado.	Actualiza un parámetro de cifrado. Asegúrese de tener permiso para llamar a la operación de API UpdateSecretValue de KMS antes de invocar esta operación.
GetSecretParameter	Obtener un parámetro cifrado y su valor.	Obtiene un parámetro cifrado, incluido su valor. Asegúrese de tener permiso para llamar a la operación de API GetSecretValue de KMS antes de invocar esta operación.
ListSecretParameters	Listar parámetros cifrados.	Consulta parámetros comunes. Se admiten múltiples métodos de consulta.
ListSecretParameterVersions	Consultar múltiples versiones de un parámetro de cifrado.	Consulta múltiples versiones de un parámetro de cifrado.
GetSecretParametersByPath	Obtener parámetros de cifrado por ruta.	Obtiene los parámetros de cifrado por ruta. Asegúrese de tener permiso para llamar a la operación de API GetSecretValue de KMS antes de invocar esta operación.
GetSecretParameters	Obtener los detalles de uno o más parámetros de cifrado.	Obtiene los detalles de uno o más parámetros de cifrado. Asegúrese de tener permiso para llamar a la operación de API GetSecretValue de KMS antes de llamar a esta operación.

Gestión de parches

API	Título	Descripción
Línea base de parches	Línea base de parches
CreatePatchBaseline	Create a patch baseline.	Crea una línea base de parches.
DeletePatchBaseline	Eliminar una línea base de parches.	Elimina una línea base de parches.
UpdatePatchBaseline	Actualizar una línea base de parches.	Actualiza una línea base de parches.
GetPatchBaseline	Get patch baseline.	Obtiene los detalles de una línea base de parches.
ListPatchBaselines	Listar líneas base de parches.	Obtiene una lista de líneas base de parches.
RegisterDefaultPatchBaseline	Registrar una línea base de parches predeterminada.	Registra una línea base de parches predeterminada.
Estado de parches	Estado de parches
ListInstancePatchStates	Listar estados de parches de instancias.	Obtiene la información de parches de las instancias.
ListInstancePatches	Listar hotfixes de instancia.	Obtiene la información de parches de una instancia.

Inventario de configuración

API	Título	Descripción
ListInventoryEntries	Consulta de registros de la lista de verificación de configuración de una instancia.	Consulta los registros de la lista de verificación de configuración de una instancia.
GetInventorySchema	GetInventorySchema.	Consulta las propiedades de una lista de configuración.
SearchInventory	Consulta de detalles o información agregada de la lista de verificación de configuración.	Consulta los detalles o la información agregada de una lista de verificación de configuración.

Configuración de estado deseado

API	Título	Descripción
CreateStateConfiguration	Crear una configuración de estado deseado.	Crea una configuración de estado deseado.
DeleteStateConfigurations	Eliminar varias configuraciones de estado deseado.	Elimina varias configuraciones de estado deseado en un lote.
UpdateStateConfiguration	Actualizar una configuración de estado deseado.	Actualiza una configuración de estado deseado.
ListStateConfigurations	Consulta las configuraciones de estado deseado.	Consulta las configuraciones de estado deseado.

Elemento de O&M

API	Título	Descripción
CreateOpsItem	Crear un OpsItem.	Crea un OpsItem.
GetOpsItem	Obtiene los detalles del elemento de O&M.	Obtiene los detalles de un elemento de O&M.
ListOpsItems	Consulta de OpsItems.	Consulta los OpsItems.
UpdateOpsItem	Actualizar un OpsItem.	Modifica un OpsItem.
DeleteOpsItems	Eliminar elementos de operaciones y mantenimiento en lote.	Elimina elementos de operaciones y mantenimiento.
GenerateOpsItem	Generate O&M items.	Genera elementos de operación y mantenimiento.

Configuración de servicio

API	Título	Descripción
SetServiceSettings	Establecer configuraciones del servicio.	Habilita o deshabilita la entrega de registros de ejecución de plantillas, especifica la ubicación de almacenamiento de la entrega y asocia un ID de empresa de China DevOps.
GetServiceSettings	Obtener información de configuración del servicio.	Obtiene la información de configuración del servicio, incluida la configuración de la función de entrega de registros de ejecución de tareas y la empresa de Apsara Devops asociada.

Gestión de aplicaciones

API	Título	Descripción
Aplicación	Aplicación
CreateApplication	Crear una aplicación.	Crea una aplicación. La región de servicio para la gestión de aplicaciones solo admite Hangzhou. Utilice el endpoint de Hangzhou.
DeleteApplication	Eliminar una aplicación.	Elimina una aplicación. La región de servicio para la gestión de aplicaciones solo admite Hangzhou. Utilice el endpoint de Hangzhou.
UpdateApplication	Actualizar una aplicación.	Actualiza una aplicación. La región de servicio para la gestión de aplicaciones solo admite Hangzhou. Utilice el endpoint de Hangzhou.
GetApplication	Obtener los detalles de una aplicación.	Obtiene los detalles de una aplicación. La región de servicio para la gestión de aplicaciones solo admite Hangzhou. Utilice el endpoint de Hangzhou.
ListApplications	Consultar lista de aplicaciones.	Consulta la lista de aplicaciones. La región de servicio para la gestión de aplicaciones solo admite Hangzhou. Utilice el endpoint de Hangzhou.
ListDeployRevisions	ListDeployRevisions.	Enumera las revisiones de una aplicación.
CreateDeployRevision	Crear un artefacto de despliegue.	Crea un artefacto de despliegue.
GetDeployRevision	GetDeployRevision.	Obtiene los detalles de una revisión de aplicación.
Grupo de aplicaciones	Grupo de aplicaciones
CreateApplicationGroup	Crear un grupo de aplicaciones.	Crea un grupo de aplicaciones. La región de servicio para la gestión de aplicaciones solo admite Hangzhou. Utilice el endpoint de Hangzhou.
DeleteApplicationGroup	Eliminar un grupo de aplicaciones.	Elimina un grupo de aplicaciones. La región de servicio para la gestión de aplicaciones solo admite Hangzhou. Utilice el endpoint de Hangzhou.
UpdateApplicationGroup	Actualizar la información de un grupo de aplicaciones.	Actualiza la información de un grupo de aplicaciones. La región de servicio para la gestión de aplicaciones solo admite Hangzhou. Utilice el endpoint de Hangzhou.
GetApplicationGroup	Obtiene los detalles de un grupo de aplicaciones.	Obtiene los detalles de un grupo de aplicaciones. El servicio de administración de aplicaciones está disponible solo en la región China (Hangzhou). Utilice el endpoint de Hangzhou.
ListApplicationGroups	Consultar grupos de aplicaciones.	Consulta la lista de grupos de aplicaciones. La región de servicio para la gestión de aplicaciones solo admite Hangzhou. Utilice el endpoint de Hangzhou.
DeployApplicationGroup	Desplegar un grupo de aplicaciones.	Despliega un grupo de aplicaciones. La gestión de aplicaciones solo se admite en la región de Hangzhou. Utilice el endpoint de Hangzhou.
ContinueDeployApplicationGroup	Continuar el despliegue de un grupo de aplicaciones.	Continúa el despliegue de un grupo de aplicaciones cuando el despliegue falla. La gestión de aplicaciones solo se admite en la región de Hangzhou. Utilice el endpoint de Hangzhou.
DescribeApplicationGroupBill	Consulta de costos de recursos del grupo de aplicaciones.	Consulta los costos de recursos de un grupo de aplicaciones.

Git

API	Título	Descripción
CheckGitRepoFileExists	Verificar si un archivo existe en un repositorio especificado.	Verifica si un archivo existe en un repositorio.
ListGitOrganizations	Consulta de organizaciones de una cuenta de inicio de sesión.	Obtiene las organizaciones de un usuario autorizado.
ListGitRepositories	Listar repositorios.	Consulta la lista de repositorios de Git.
CreateGitRepository	Crear un repositorio de Git.	Crea un repositorio.
ListGitAccounts	Listar cuentas de Git vinculadas.	Obtiene las cuentas de plataforma administradas que el usuario actual de Alibaba Cloud ha autorizado en la gestión de aplicaciones.
ListGitBranches	Consulta de ramas de un repositorio especificado.	Obtiene todas las ramas de un repositorio de Git especificado.
CheckGitRepositoryExists	Comprobar si existe un repositorio.	Comprueba si existe un repositorio.
GetGitBranch	Obtener detalles de la rama.	Consulta los detalles de una rama de Git. Admite la consulta de repositorios públicos sin autorización.
ListGitRepositoryContents	Obtener contenido de archivos y directorios del repositorio.	Obtiene información de archivos y directorios de un repositorio.

Etiqueta

API	Título	Descripción
ListTagKeys	Consulta de etiquetas creadas.	Consulta las etiquetas creadas.
ListTagValues	Consultar valores de etiqueta creados.	Consulta los valores de etiqueta creados.
ListTagResources	Consultar relaciones entre recursos y etiquetas.	Consulta las relaciones visibles entre recursos y etiquetas.
UntagResources	Eliminar relaciones entre etiquetas de usuario y recursos.	Elimina las relaciones entre etiquetas de usuario y recursos para quitar las etiquetas de usuario de los recursos.
TagResources	Crear relaciones etiqueta-recurso.	Crea relaciones etiqueta-recurso para agregar etiquetas de usuario a los recursos.

Grupo de recursos

API	Título	Descripción
ChangeResourceGroup	Cambiar grupo de recursos.	Modifica el grupo de recursos al que pertenece un recurso en la nube.

Extensión

API	Título	Descripción
UpdateInstancePackageState	Actualizar una extensión instalada en una instancia.	Actualiza una extensión instalada en una instancia.
ListInstancePackageStates	Consulta de extensiones instaladas en una instancia.	Enumera los estados de los paquetes de software de una instancia.

Configuración del asistente de IA

API	Título	Descripción
CreateChatConfiguration	Crear una configuración de chat.	Crea, actualiza, consulta y elimina configuraciones de chat para plataformas como DingTalk.
UpdateChatConfiguration	Actualizar configuración de chat.	Crea, actualiza, consulta y elimina configuraciones de chat para plataformas como DingTalk.
GetChatConfiguration	Ver configuración de chat.	Crea, actualiza, consulta y elimina configuraciones de chat para plataformas como DingTalk.
ListChatConfigurations	Listar configuraciones de chat.	Crea, actualiza, consulta y elimina configuraciones de chat para plataformas como DingTalk.
DeleteChatConfiguration	Eliminar una configuración de conversación.	Crea, actualiza, consulta y elimina configuraciones de chat para plataformas como DingTalk.