This topic describes how to manage schemas in the EventBridge console. For example, you can create and delete schemas, and view the details of schemas.

Prerequisites

Activate EventBridge and grant permissions to a RAM user
Note You can only view the details of the schemas and schema versions that correspond to Alibaba Cloud service events in the EventBridge console, but cannot create, modify, or delete the schemas and schema versions.

Create a schema

  1. Log on to the EventBridge console.
  2. In the left-side navigation pane, click Schemas.
  3. In the top navigation bar, select a region.
  4. On the Schemas page, click the Custom Schema Groups tab. On the Custom Schema Groups tab, click Create Schema.
  5. In the Create Schema panel, enter a schema ID, a schema description, and schema content, select a compatible type, and then click OK.
    Note The compatible type affects whether changes to fields of the schema are accepted.

View the details of a schema

  1. Log on to the EventBridge console.
  2. In the left-side navigation pane, click Schemas.
  3. In the top navigation bar, select a region.
  4. On the Schemas page, click the Custom Schema Groups tab or the Schema Groups for Cloud Service Events tab. On the tab that appears, find the schema whose details you want to view and click Details in the Operations column.
    On the details page of the schema, view the basic information, content, and versions of the schema.

Modify a schema

  1. Log on to the EventBridge console.
  2. In the left-side navigation pane, click Schemas.
  3. In the top navigation bar, select a region.
  4. On the Schemas page, click the Custom Schema Groups tab. On the Custom Schema Groups tab, find the schema that you want to modify and click Edit in the Operations column.
  5. In the Modify Schema panel, modify the description or content of the schema, and click OK.

Delete a schema

  1. Log on to the EventBridge console.
  2. In the left-side navigation pane, click Schemas.
  3. In the top navigation bar, select a region.
  4. On the Schemas page, click the Custom Schema Groups tab. On the Custom Schema Groups tab, find the schema that you want to delete and click Delete in the Operations column.
  5. In the Note message, read the note and click OK.

Register a schema version

Notice If the content of the new version of a schema is the same as that of the previous version, no new version is registered.
  1. Log on to the EventBridge console.
  2. In the left-side navigation pane, click Schemas.
  3. In the top navigation bar, select a region.
  4. On the Schemas page, click the Custom Schema Groups tab. On the Custom Schema Groups tab, find the schema for which you want to register a new version and click Details in the Operations column.
  5. On the details page of the schema, click the Versions tab. On the Versions tab, click Register New Version.
  6. In the Register New Version panel, enter schema content in the Content code editor and click OK.

View the details of a schema version

  1. Log on to the EventBridge console.
  2. In the left-side navigation pane, click Schemas.
  3. In the top navigation bar, select a region.
  4. On the Schemas page, click the Custom Schema Groups tab or the Schema Groups for Cloud Service Events tab. On the tab that appears, find the schema whose version details you want to view and click Details in the Operations column.
  5. On the details page of the schema, click the Versions tab. On the Versions tab, find the version whose details you want to view and click Details in the Operations column.
    On the Version Details page, view the basic information and schema definition of the version.

Delete a schema version

  1. Log on to the EventBridge console.
  2. In the left-side navigation pane, click Schemas.
  3. In the top navigation bar, select a region.
  4. On the Schemas page, click the Custom Schema Groups tab. On the Custom Schema Groups tab, find the schema whose version you want to delete and click Details in the Operations column.
  5. On the details page of the schema, click the Versions tab. On the Versions tab, find the version that you want to delete and click Delete in the Operations column.
  6. In the Note message, read the note and click OK.