Actualización de conjuntos de reglas y reglas con la CLI del kit de herramientas

Editar en línea

Utilice la CLI del kit de herramientas API Connect para actualizar un conjunto de reglas o reglas individuales.

Actualización de un conjunto de reglas

Cree un archivo JSON que defina el conjunto de reglas actualizado.
El ejemplo siguiente muestra un conjunto de reglas actualizado:
```
{
    "title": "custom-ruleset-2",
    "description": "short ruleset updated",
    "ruleset_type": "custom"
}
```
donde:
- title se actualiza a un nuevo título para el conjunto de reglas.
- description se actualiza a una nueva descripción para el conjunto de reglas.
- ruleset_type se actualiza para que sea personalizado para el conjunto de reglas.
Inicie sesión en el kit de herramientas como administrador o como propietario de la organización de proveedores propietaria del conjunto de reglas.
Ejecute el mandato de kit de herramientas rulesets:update en modalidad governance :
```
apic -m governance rulesets:update --org <target_org> --server <platform_api_host_name> RULESET RULESET_FILE
```
donde:
- <target_org> es el nombre de la organización propietaria del conjunto de reglas.
- <platform_api_host_name> es la parte del nombre de host URL del servidor que aloja el Gestor de API (el "servidor de gestión").
  
  Consejo: Para determinar el nombre de host, puede abrir el Gestor de API en un navegador y copiar el nombre de host de la URL en la barra de direcciones (empezando después de https:// y terminando antes de /manager ).
- RULESET_FILE es la vía de acceso y el nombre de archivo del archivo JSON que contiene el conjunto de reglas actualizado.
- RULESET es el nombre o el ID exclusivo del conjunto de reglas actualizado.
  Para determinar el ID de un conjunto de reglas, ejecute el mandato siguiente:
```
apic -m governance rulesets:list --org <target_org> --server <platform_api_host_name>
```

Actualización de una regla

Cree un archivo JSON que defina la regla actualizada.
El ejemplo siguiente muestra una regla actualizada:
```
{
  "description": "Updated the rule",
  "message": "Schema of type array must specify maxItems and minItems. {{path}} {{error}}",
  "formats": [
    "oas3"
  ],
  "severity": "warn",
  "recommended": true,
  "given": [
    "$..[?(@.type==\"array\")]"
  ]
}
```
donde:
- description se actualiza a un nuevo título para la regla
- message se actualiza a un nuevo mensaje para la regla
- La matriz formats se sustituye para que solo tenga el formato oas3 para la regla
- severity se actualiza al valor de aviso para la regla
- recommended se actualiza para tener un nuevo valor para la regla
- La matriz given se sustituye para tener nuevos valores para la regla
Inicie sesión en el kit de herramientas como administrador o como propietario de la organización de proveedores propietaria de la regla.
Ejecute el mandato del kit de herramientas de rules:update en modalidad governance .
Hay dos formas de especificar la regla actualizada en el mandato, en función de si proporciona el nombre y la versión de la regla o el ID de la regla:
Especifique el nombre de regla y la versión en el mandato de actualización
```
apic -m governance rules:update --org <target_org> --server <platform_api_host_name> --ruleset <ruleset_name or ruleset_id> NAME:VERSION RULE_FILE
```
donde:
- <target_org> es el nombre de la organización propietaria de la regla.
- <platform_api_host_name> es la parte del nombre de host URL del servidor que aloja el Gestor de API (el "servidor de gestión").
  
  Consejo: Para determinar el nombre de host, puede abrir el Gestor de API en un navegador y copiar el nombre de host de la URL en la barra de direcciones (empezando después de https:// y terminando antes de /manager ).
- <ruleset_name or ruleset_id> es el nombre o el ID exclusivo del conjunto de reglas al que pertenece la regla actualizada.
- NAME es el nombre de la regla actualizada.
- VERSION es la versión de la regla actualizada; aumente la versión cuando actualice la regla, utilizando el formato major.minor.patch como en "1.0.1".
- RULE_FILE es la vía de acceso y el nombre de archivo del archivo JSON que contiene la regla actualizada.
Especifique el ID de regla en el mandato de actualización
En lugar de proporcionar el nombre y la versión de la regla, puede proporcionar su ID exclusivo ejecutando el mandato siguiente:
```
apic -m governance rules:update --org <target_org> --server <platform_api_host_name> --ruleset <ruleset_name or ruleset_id> --id <rule_id> RULE_FILE
```
donde:
- <target_org> es el nombre de la organización propietaria de la regla.
- <platform_api_host_name> es la parte del nombre de host URL del servidor que aloja el Gestor de API (el "servidor de gestión").
  
  Consejo: Para determinar el nombre de host, puede abrir el Gestor de API en un navegador y copiar el nombre de host de la URL en la barra de direcciones (empezando después de https:// y terminando antes de /manager ).
- <ruleset_name or ruleset_id> es el nombre o el ID exclusivo del conjunto de reglas al que pertenece la regla de actualización.
- RULE_FILE es la vía de acceso y el nombre de archivo del archivo JSON que contiene la regla actualizada.
- <rule_id> es el valor del ID exclusivo de la regla actualizada.
  Para determinar el ID de una regla, ejecute el mandato siguiente:
  apic -m governance rules:list --org <target_org> --server <platform_api_host_name> --ruleset <ruleset_name> RULE_NAME