插件管理

1.1 插件列表查询

Url：

Action	请求方法	备注
DescribePlugins	GET	同步接口

Request Params：

请求参数	数据类型	是否必填	备注
RabbitmqVersion	String	是	选填，rabbitmq版本号，默认值为3.6.6。
IsEssential	Boolean	否	选填，true表示返回必装插件列表，false表示返回非必装自定义插件列表。默认值为true。

Response Params：

响应参数	数据类型	备注
PluginSet	String	插件id
RabbitmqVersion	String	RabbitMQ 版本
IsEssential	Boolean	是否必装(true必装)

PluginSet：

响应参数	数据类型	备注
Id	String	插件id
PluginName	String	表示插件名称
Type	String	插件类型(official官方插件，community社区插件)
Description	String	插件描述

demo：

请求实例：

curl --request GET \
  --url 'https://open.cn-east-1.163yun.com/nqs?Action=DescribePlugins&Version=2017-12-01' \

请求响应：

http status code
2xx : 请求成功 
4xx : 客户端错误 
5xx : 服务端错误（客户端可重试）   

成功：
{
    "RequestId": "123",
    "RabbitmqVersion": "3.6.6",
    "PluginSet": [
        {
            "Id": "787a992019b8c83f943a80b8d25c29c1",
            "PluginName": "rabbitmq_management",
            "Type": "official",
            "Description": "RabbitMQ管理后台插件"
        }
    ],
    "IsEssential": true
}
{
    "Code":"InvalidParameterValue",  
    "Message":"Value xxx for parameter InstanceId is invalid",
    "RequestId":"bcdf0f8b-767d-4a9e-b63f-e188ce5af96f"
}  

1.2 已安装插件列表查询

Url：

Action	请求方法	备注
DescribeInstalledPlugins	GET	同步接口

Request Params：

请求参数	数据类型	是否必填	备注
InstanceId	String	是	实例Id

Response Params：

响应参数	数据类型	备注
PluginSet	String	插件id

PluginSet：

响应参数	数据类型	备注
Id	String	插件id
PluginName	String	表示插件名称
RabbitmqVersion	String	RabbitMQ 版本
Type	ENUM	插件类型(official官方插件，community社区插件)
IsEssential	Boolean	是否必装(true必装)
Description	String	插件描述

demo：

请求实例：

curl --request GET \
  --url 'https://open.cn-east-1.163yun.com/nqs?Action=DescribeInstalledPlugins&Version=2017-12-01&InstanceId=db97fff962da4b92bdea5a57862e90bb' \

请求响应：

http status code
2xx : 请求成功 
4xx : 客户端错误 
5xx : 服务端错误（客户端可重试）   

成功：
{
    "RequestId": "123",
    "PluginSet": [
        {
            "Id": "c500d2d8489a0a4e4c827920d0b08a76",
            "PluginName": "rabbitmq_mqtt",
            "Type": "official",
            "Description": "mqtt协议适配插件",
            "RabbitmqVersion": "3.6.6",
            "IsEssential": false
        },
        {
            "Id": "b6299be45537789afdfaac32ce143433",
            "PluginName": "rabbitmq_delayed_message_exchange",
            "Type": "community",
            "Description": "支持延迟/定时消息发送插件",
            "RabbitmqVersion": "3.6.6",
            "IsEssential": false
        },
        {
            "Id": "4ce616aebbfb264dedefa2a638adf44c",
            "PluginName": "rabbitmq_web_stomp",
            "Type": "official",
            "Description": "通过WebSocket协议访问消息队列插件",
            "RabbitmqVersion": "3.6.6",
            "IsEssential": false
        }
    ]
}

失败：
{
    "Code":"InvalidParameterValue",  
    "Message":"Value xxx for parameter InstanceId is invalid",
    "RequestId":"bcdf0f8b-767d-4a9e-b63f-e188ce5af96f"
}  

1.3 实例插件安装

Url：

Action	请求方法	备注
InstallPlugins	POST	异步接口

Request Body：

请求参数	数据类型	是否必填	备注
InstanceId	String	是	实例Id
PluginIdSet	Array	是	插件 id 列表

demo：

请求实例：

curl --request POST \
  --url 'https://open.cn-east-1.163yun.com/nqs?Action=InstallPlugins&Version=2017-12-01' \
  --data '{\n	"InstanceId":"e8b9f858ac464af69786c99e945f9562",\n	"PluginIdSet":["3e3b38c82fc00d0dd4367537d06bc7ec","4ce616aebbfb264dedefa2a638adf44c"]\n}'

请求响应：

http status code
2xx : 请求成功 
4xx : 客户端错误 
5xx : 服务端错误（客户端可重试）   

成功：
{
    "Code": "Success",
    "RequestId": "123"
}
失败：
{
    "Code":"InvalidParameterValue",  
    "Message":"Value xxx for parameter InstanceId is invalid",
    "RequestId":"bcdf0f8b-767d-4a9e-b63f-e188ce5af96f"
}  

1.4 实例插件卸载

Url：

Action	请求方法	备注
UninstallPlugins	POST	异步接口

Request Body：

请求参数	数据类型	是否必填	备注
InstanceId	String	是	实例Id
PluginIds.N	Array	是	插件 id 列表

demo：

请求实例：

curl --request POST \
  --url 'https://open.cn-east-1.163yun.com/nqs?Action=UninstallPlugins&Version=2017-12-01' \
  --data '{\n	"InstanceId":"e8b9f858ac464af69786c99e945f9562",\n	"PluginIdSet":["3e3b38c82fc00d0dd4367537d06bc7ec","4ce616aebbfb264dedefa2a638adf44c"]\n}'

请求响应：

http status code
2xx : 请求成功 
4xx : 客户端错误 
5xx : 服务端错误（客户端可重试）   

成功：
{
    "Code": "Success",
    "RequestId": "123"
}
失败：
{
    "Code":"InvalidParameterValue",  
    "Message":"Value xxx for parameter InstanceId is invalid",
    "RequestId":"bcdf0f8b-767d-4a9e-b63f-e188ce5af96f"
}