Skip to main content
API Explorer|API Explorer
Resource Center/Network Resource/Multicast Routing Operations
PUTMulticast Routing OperationsSince 3.7.0SynchronousAuth Required

ChangeMulticastRouterState

ChangeMulticastRouterState

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Request Inputs

Path Parameters

  • uuidStringRequired

    The resource UUID.

Body Fields

  • changemulticastrouterstateObjectRequired

    changemulticastrouterstate request body object.

    • stateEventStringRequired

      状态事件。

  • systemTagsList

    Optional. The system tags.

  • userTagsList

    Optional. The user tags.

Responses

200 OK

On success, this API returns the following response structure.

  • errorErrorCodeRequired

    The error code. If not null, the operation fails, or vice versa. For more information, see error.

    • codeStringRequired

      The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.

    • descriptionStringRequired

      The brief description of the error.

    • detailsStringRequired

      The details about the error.

    • elaborationStringRequired

      The reserved field. Default value: null.

    • opaqueLinkedHashMapRequired

      The reserved field. Default value: null.

    • causeErrorCodeRequired

      The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.

  • inventoryMulticastRouterInventoryRequired

    See inventory.

    • uuidStringRequired

      The resource UUID.

    • vpcRouterUuidStringRequired

      No description provided.

    • descriptionStringRequired

      The detailed description of the resource.

    • stateStringRequired

      当前状态。

    • createDateTimestampRequired

      The creation date.

    • lastOpDateTimestampRequired

      The last operation date.

    • rpGroupsListRequired

      See rpGroups.

      • uuidStringRequired

        The resource UUID.

      • multicastRouterUuidStringRequired

        No description provided.

      • rpAddressStringRequired

        No description provided.

      • groupAddressStringRequired

        组地址。

      • createDateTimestampRequired

        The creation date.

      • lastOpDateTimestampRequired

        The last operation date.

    • vpcVrsListRequired

      See vpcVrs.

      • uuidStringRequired

        The resource UUID.

      • vpcRouterUuidStringRequired

        No description provided.

Endpoint

PUT/zstack/v1/multicast/virtual-routers/{uuid}/actions

/zstack/v1/multicast/virtual-routers/{uuid}/actions

Operation ID

ChangeMulticastRouterState

Permalink

Request Example

curl -X PUT 'http://{host}/zstack/v1/multicast/virtual-routers/{uuid}/actions' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"changemulticastrouterstate":{"stateEvent":"<stateEvent>"},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

Response Example

200
{ "inventory": { "uuid": "93ce20a6a51932ce8f544033d5cdca3c", "description": "test for header", "rpGroups": [ { "uuid": "3ef422d857ff3a09a6c000900ac37f78", "multicastRouterUuid": "93ce20a6a51932ce8f544033d5cdca3c", "rpAddress": "1.2.3.4", "groupAddress": "239.1.1.1/32" } ], "vpcVrs": [] } }

Change History

This API has no change history records yet.

View all change history