### Start Instance Source: https://my.idcsmart.com/v1/doc Starts a specified cloud instance. ```APIDOC ## POST /admin/v1/remf_cloud/:id/on ### Description Starts a specified cloud instance. ### Method POST ### Endpoint /admin/v1/remf_cloud/:id/on ### Parameters #### Path Parameters - **id** (int) - Required - Product ID #### Request Body - **admin_operate_password** (string) - Optional - Operation password, pass when verification is required ``` -------------------------------- ### Install Object Storage Plugin Source: https://my.idcsmart.com/v1/doc Installs an object storage plugin. Requires the plugin name. ```APIDOC ## POST /admin/v1/plugin/oss/:name ### Description Installs an object storage plugin. ### Method POST ### Endpoint /admin/v1/plugin/oss/:name ### Parameters #### Path Parameters - **name** (string) - Required - The identifier of the plugin to install. ``` -------------------------------- ### GET /console/v1/remf_finance_common Source: https://my.idcsmart.com/v1/doc Retrieves a list of products. ```APIDOC ## GET /console/v1/remf_finance_common ### Description Retrieves a list of products. ### Method GET ### Endpoint /console/v1/remf_finance_common ### Parameters #### Query Parameters - **page** (int) - Optional - Page number (default: 1) - **limit** (int) - Optional - Items per page - **orderby** (string) - Optional - Sort by (id, due_time, status) - **sort** (string) - Optional - Sort order (asc/desc) - **keywords** (string) - Optional - Keyword search (package name/hostname/IP) - **status** (string) - Optional - Product status (Unpaid, Pending, Active, Suspended, Deleted) - **tab** (string) - Optional - Tab filter (using, expiring, overdue, deleted) - **m** (int) - Optional - Menu ID ### Response #### Success Response (200) - **list[]** (object) - List of products. - **list[].id** (int) - Product ID. - **list[].name** (string) - Product identifier. - **list[].status** (string) - Product status (Unpaid, Pending, Active, Suspended, Deleted). - **list[].due_time** (int) - Due date. - **list[].active_time** (int) - Activation time. - **list[].product_name** (string) - Product name. - **list[].is_auto_renew** (int) - Auto-renewal status (0=No, 1=Yes). - **count** (int) - Total number of items. - **using_count** (int) - Number of items in use. - **expiring_count** (int) - Number of items expiring soon. - **overdue_count** (int) - Number of overdue items. - **deleted_count** (int) - Number of deleted items. ``` -------------------------------- ### Get Upgrade Recommend Config Source: https://my.idcsmart.com/v1/doc Retrieves a list of recommended configurations for upgrading or downgrading a product package. ```APIDOC ## GET /console/v1/mf_cloud/:id/recommend_config ### Description Gets recommended configurations for package upgrades or downgrades. ### Method GET ### Endpoint /console/v1/mf_cloud/:id/recommend_config ### Parameters #### Path Parameters - **id** (int) - Required - Product ID ### Response #### Success Response (200) - **list[].id** (int) - Package ID - **list[].product_id** (int) - Product ID - **list[].name** (string) - Package name - **list[].description** (string) - Package description - **list[].order** (int) - Order ID - **list[].data_center_id** (int) - Data center ID - **list[].cpu** (int) - CPU cores - **list[].memory** (int) - Memory in GB - **list[].system_disk_size** (int) - System disk size in GB - **list[].data_disk_size** (int) - Data disk size in GB - **list[].bw** (int) - Bandwidth in Mbps - **list[].peak_defence** (int) - Peak defense in G - **list[].system_disk_type** (string) - System disk type - **list[].data_disk_type** (string) - Data disk type - **list[].flow** (int) - Traffic - **list[].line_id** (int) - Line ID - **list[].create_time** (int) - Creation time - **list[].ip_num** (int) - Number of IPs - **list[].upgrade_range** (int) - Upgrade/downgrade range (0=not allowed, 1=all, 2=custom) - **list[].hidden** (int) - Hidden status (0=no, 1=yes) - **list[].gpu_num** (int) - Number of GPUs - **list[].ipv6_num** (int) - Number of IPv6 addresses - **list[].gpu_name** (string) - GPU name - **list[].bill_type** (string) - Billing type (bw=bandwidth, flow=traffic) - **count** (int) - Total number of items ``` -------------------------------- ### GET /console/v1/product/:id/remf_finance_common/order_page Source: https://my.idcsmart.com/v1/doc Retrieves the configuration for the order page. ```APIDOC ## GET /console/v1/product/:id/remf_finance_common/order_page ### Description Retrieves the configuration for the order page. ### Method GET ### Endpoint /console/v1/product/:id/remf_finance_common/order_page ### Parameters #### Path Parameters - **id** (int) - Required - Product ID ``` -------------------------------- ### Get Instance Detail Source: https://my.idcsmart.com/v1/doc Retrieves detailed information for a specific IDC instance. ```APIDOC ## GET /console/v1/rewhmcs_dcim/:id ### Description Retrieves detailed information for a specific IDC instance. ### Method GET ### Endpoint /console/v1/rewhmcs_dcim/:id ### Parameters #### Path Parameters - **id** (int) - Required - Product ID ### Response #### Success Response (200) - **serverid** (int) - Server ID - **server** (object) - Server details - **server.id** (string) - Server ID - **server.wltag** (string) - Physical tag - **server.osname** (string) - Operating system name - **server.power** (string) - Power status - **server.power_msg** (string) - Power status description - **server.osusername** (string) - Operating system username - **server.ospassword** (string) - Operating system password - **server.crack_success_info** (string) - Cracked password information - **server.crack_user** (string) - Cracked user - **server.default_user** (string) - Default user - **server.ippassword** (string) - Panel password - **server.port** (string) - Port - **server.main_ip** (string) - Main IP address - **server.configoptionsupgrade** (string) - Indicates if upgrade/downgrade is supported (0=No, 1=Yes) - **ip** (array) - Additional IP addresses - **ip[].ipaddress** (string) - IP address - **ip[].subnetmask** (string) - Subnet mask - **ip[].gateway** (string) - Gateway - **configoptions** (object) - Current configuration - **configoptions.area.name** (object) - Configuration area name - **configoptions.area.value** (object) - Configuration area value - **oldconfigoptions** (object) - Values for current configuration IDs (e.g., {"1":1,"2":2}) - **customfields** (object) - Custom fields ``` -------------------------------- ### Get Product Details Source: https://my.idcsmart.com/v1/doc Retrieves detailed information about a specific product. ```APIDOC ## GET /product/detail ### Description Retrieves detailed information for a specific product, including its billing configuration. ### Method GET ### Endpoint /product/detail ### Parameters #### Query Parameters - **param.product_id** (int) - Required - The ID of the product to retrieve. ### Response #### Success Response (200) - **product** (object) - Detailed product information, including billing parameters. ``` -------------------------------- ### Start Rescue Mode Source: https://my.idcsmart.com/v1/doc Initiates rescue mode for a specified instance, allowing for system recovery and maintenance. ```APIDOC ## POST /console/v1/remf_cloud/:id/rescue/start ### Description Starts rescue mode for the specified instance. ### Method POST ### Endpoint /console/v1/remf_cloud/:id/rescue/start ### Parameters #### Path Parameters - **id** (int) - Required - Product ID #### Request Body - **type** (int) - Required - Specifies the rescue system type (1=windows, 2=linux) - **password** (string) - Required - Temporary password for the rescue system - **client_operate_password** (string) - Optional - Operation password, required for verification ``` -------------------------------- ### Get Product Details Source: https://my.idcsmart.com/v1/doc Retrieves detailed information about a specific product. ```APIDOC ## GET /console/v1/host/{id} ### Description Retrieves detailed information about a specific product. ### Method GET ### Endpoint /console/v1/host/{id} ### Parameters #### Path Parameters - **id** (int) - Required - Product ID. #### Query Parameters - **id** (int) - Required - Product ID. ### Response #### Success Response (200) - **host** (object) - Product details. - **host.id** (int) - Product ID. - **host.order_id** (int) - Order ID. - **host.product_id** (int) - Product ID. - **host.name** (string) - Product identifier. - **notes** (string) - Remarks. - **host.first_payment_amount** (string) - Initial payment amount. - **host.renew_amount** (string) - Renewal amount. - **host.billing_cycle** (string) - Billing cycle. - **host.billing_cycle_name** (string) - Billing cycle name. - **host.billing_cycle_time** (string) - Billing cycle time in seconds. - **host.active_time** (int) - Activation time. - **host.due_time** (int) - Due time. - **host.status** (string) - Status (Unpaid, Pending, Active, Suspended, Deleted, Failed). - **host.suspend_type** (string) - Suspension type (overdue, overtraffic, certification_not_complete, other). - **host.suspend_reason** (string) - Reason for suspension. - **host.ratio_renew** (int) - Whether ratio renewal is enabled (0: No, 1: Yes). - **host.base_price** (string) - Base price for the billing cycle. - **host.product_name** (string) - Product name. - **host.agent** (int) - Whether it is an agent product (0: No, 1: Yes). - **host.upstream_host_id** (string) - Upstream product ID. - **host.base_info** (string) - Basic product information. - **host.auto_release_time** (int) - Auto-release time (0: Not set). - **host.keep_time_price** (string) - Keep time price. - **host.on_demand_flow_price** (string) - On-demand flow price. - **host.on_demand_billing_cycle_unit** (string) - On-demand billing cycle unit (hour, day, month). - **host.on_demand_billing_cycle_day** (int) - On-demand billing cycle day. - **host.on_demand_billing_cycle_point** (string) - On-demand billing cycle time point (e.g., 00:00). - **host.change_billing_cycle_id** (int) - Whether a change to on-demand billing cycle has been applied for (0: No, >0: Yes). - **host.addition.country_id** (int) - Country ID for additional information. - **host.addition.city** (string) - City for additional information. - **host.addition.area** (string) - Area for additional information. - **host.addition.image_icon** (string) - Image icon (e.g., Windows, CentOS, Ubuntu). - **host.addition.image_name** (string) - Image name. - **host.addition.username** (string) - Instance username. - **host.addition.password** (string) - Instance password. - **host.addition.port** (int) - Port number. - **host.product_on_demand.client_auto_delete** (int) - Client auto-delete setting for on-demand products. ``` -------------------------------- ### Get Product Global Notice Actions Source: https://my.idcsmart.com/v1/doc Retrieves the global notice actions for products. ```APIDOC ## GET /productNoticeSetting ### Description Retrieves the global notice actions for products. ### Method GET ### Endpoint /productNoticeSetting ### Response #### Success Response (200) - **[].name** (string) - Action identifier - **[].name_lang** (string) - Action name ``` -------------------------------- ### home_Hooks_after_plugin_install Source: https://my.idcsmart.com/v1/doc Hook triggered after a plugin is installed. Requires plugin name and custom fields. ```APIDOC ## POST /home/Hooks/after_plugin_install ### Description Hook triggered after a plugin is installed. Requires plugin name and custom fields. ### Method POST ### Endpoint /home/Hooks/after_plugin_install ### Parameters #### Path Parameters - **name** (string) - Required - desc:插件标识 - **customfield** (object) - Required - desc:自定义字段 (键值对格式) ### Request Example { "name": "plugin_name", "customfield": { "key": "value" } } ### Response #### Success Response (200) - **status** (int) - desc:状态码200 - **msg** (string) - desc:返回消息 ``` -------------------------------- ### Get Product On-Demand Configuration Source: https://my.idcsmart.com/v1/doc Retrieves the on-demand billing configuration for a product. ```APIDOC ## GET /getProductOnDemand ### Description Retrieves the on-demand billing configuration details for a specific product. This method is optimized to query only once per product. ### Method GET ### Endpoint /getProductOnDemand ### Parameters #### Query Parameters - **productId** (int) - Required - The ID of the product. ### Response #### Success Response (200) - **ProductOnDemandModel** (object) - An object containing the on-demand billing configuration. ``` -------------------------------- ### Get Product Configuration Durations Source: https://my.idcsmart.com/v1/doc Retrieves all available pricing durations for a given product. Requires the product ID. ```APIDOC ## GET /console/v1/product/:id/remf_finance/duration ### Description Retrieves all available pricing durations for a given product. ### Method GET ### Endpoint /console/v1/product/:id/remf_finance/duration ### Parameters #### Path Parameters - **id** (int) - Required - 商品ID ### Response #### Success Response (200) - **duration** (object) - 周期 - **duration.product_price** (float) - 产品价格 ``` -------------------------------- ### Get Instance Status Source: https://my.idcsmart.com/v1/doc Retrieves the current status and description of a finance instance. ```APIDOC ## GET /console/v1/remf_finance/:id/status ### Description Retrieves the current status and description of a finance instance. ### Method GET ### Endpoint /console/v1/remf_finance/:id/status ### Parameters #### Path Parameters - **id** (int) - Required - 产品ID ### Response #### Success Response (200) - **data.status** (string) - 实例状态 (pending=开通中, on=开机, off=关机, operating=操作中, fault=故障) - **data.desc** (string) - 实例状态描述 ``` -------------------------------- ### Get Instance Status Source: https://my.idcsmart.com/v1/doc Retrieves the current status of a product instance. Requires the product ID. ```APIDOC ## GET /console/v1/remf_finance_common/:id/status ### Description Retrieves the current status of a product instance. ### Method GET ### Endpoint /console/v1/remf_finance_common/:id/status ### Parameters #### Path Parameters - **id** (int) - Required - Product ID ### Response #### Success Response (200) - **data.status** (string) - Instance status (pending=pending, on=powered on, off=powered off, operating=operating, fault=fault) - **data.desc** (string) - Description of the instance status ``` -------------------------------- ### Get Instance List Source: https://my.idcsmart.com/v1/doc Retrieves a list of IDC instances with various details and counts. ```APIDOC ## GET /console/v1/rewhmcs_dcim ### Description Retrieves a list of IDC instances with various details and counts. ### Method GET ### Endpoint /console/v1/rewhmcs_dcim ### Parameters #### Query Parameters - **page** (int) - Optional - Page number - **limit** (int) - Optional - Number of items per page - **status** (string) - Optional - Instance status (e.g., running, stopped, fault=故障) ### Response #### Success Response (200) - **list** (array) - List of instances - **list[].id** (int) - Instance ID - **list[].name** (string) - Instance name - **list[].status** (string) - Instance status - **list[].create_time** (string) - Instance creation time - **list[].image_name** (string) - Image name - **list[].image_icon** (string) - Image icon - **list[].ip_num** (int) - Number of IPs - **list[].dedicate_ip** (string) - Primary IP - **list[].assign_ip** (string) - Additional IPs (comma-separated) - **list[].self_defined_field** (object) - Custom field values - **list[].is_auto_renew** (int) - Auto-renewal status (0=No, 1=Yes) - **count** (int) - Total number of items - **using_count** (int) - Number of items in use - **expiring_count** (int) - Number of expiring items - **overdue_count** (int) - Number of overdue items - **deleted_count** (int) - Number of deleted items - **all_count** (int) - Total count of all items - **data_center** (array) - Data center information - **data_center[].country_id** (int) - Country ID - **data_center[].city** (string) - City - **data_center[].area** (string) - Area - **data_center[].country_name** (string) - Country name - **data_center[].country_code** (string) - Country code - **self_defined_field** (array) - Custom field definitions - **self_defined_field[].id** (int) - Custom field ID - **self_defined_field[].field_name** (string) - Custom field name - **self_defined_field[].field_type** (string) - Field type (text, link, password, dropdown, tickbox, textarea) ``` -------------------------------- ### Get Product Notice Action Status Source: https://my.idcsmart.com/v1/doc Retrieves the status of product notice actions. ```APIDOC ## GET /getProductNoticeStatus ### Description Retrieves the status of product notice actions. ### Method GET ### Endpoint /getProductNoticeStatus ### Response #### Success Response (200) - **type** (string) - Notification type identifier - **product_id** (string) - Product - **act** (string) - Product action - **-** (string) - Placeholder for response value ``` -------------------------------- ### Get Instance Details Source: https://my.idcsmart.com/v1/doc Retrieves detailed information about a specific cloud instance, including operating system details, configuration, and billing information. ```APIDOC ## GET /admin/v1/remf_cloud/:id ### Description Retrieves detailed information about a specific cloud instance. ### Method GET ### Endpoint /admin/v1/remf_cloud/:id ### Parameters #### Path Parameters - **id** (int) - Required - Product ID ### Response #### Success Response (200) - **image[].id** (int) - Operating system category ID - **image[].name** (string) - Operating system category name - **image[].icon** (string) - Operating system category icon - **image[].image[].id** (int) - Operating system ID - **image[].image[].image_group_id** (int) - Operating system category ID - **image[].image[].name** (string) - Operating system name - **image[].image[].charge** (int) - Whether it is charged (0=no, 1=yes) - **image[].image[].price** (string) - Price - **config.type** (string) - Instance type (host=KVM enhanced, lightHost=KVM lightweight, hyperv=Hyper-V) - **config.support_ssh_key** (int) - Whether SSH key is supported (0=no, 1=yes) - **config.rand_ssh_port** (int) - SSH port setting (0=default, 1=random port, 2=specified port) - **config.rand_ssh_port_start** (string) - Random port start port - **config.rand_ssh_port_end** (string) - Random port end port - **config.rand_ssh_port_windows** (string) - Specified port Windows - **config.rand_ssh_port_linux** (string) - Specified port Linux - **line.bill_type** (string) - Billing type (bw=bandwidth billing, flow=traffic billing) ``` -------------------------------- ### Get Module Chart Data Source: https://my.idcsmart.com/v1/doc Retrieves chart data for a specific module within a finance instance. Allows filtering by type, select, start, and end times. ```APIDOC ## GET /console/v1/remf_finance/:id/chart ### Description Retrieves chart data for a specific module within a finance instance. ### Method GET ### Endpoint /console/v1/remf_finance/:id/chart ### Parameters #### Query Parameters - **type** (string) - Required - module_chart里面的type (e.g., cpu, dist, memory, flow) - **select** (string) - Optional - module_chart里面的select的value - **start** (int) - Optional - 开始毫秒时间戳 - **end** (int) - Optional - 结束毫秒时间戳 ### Response #### Success Response (200) - **unit** (unit) - 单位 - **chart_type** (line) - chart_type:line线性图 - **list** (list) - 图表数据 - **label** (label) - 对应list鼠标over显示内容 - **time** (time) - 时间 - **value** (value) - 值 ``` -------------------------------- ### Get Console Address Source: https://my.idcsmart.com/v1/doc Retrieves the console access address for a cloud product instance. Requires the instance ID. ```APIDOC ## POST /console/v1/mf_cloud/:id/vnc ### Description Retrieves the console access address for a cloud product instance. ### Method POST ### Endpoint /console/v1/mf_cloud/:id/vnc ### Parameters #### Path Parameters - **id** (int) - Product ID ``` -------------------------------- ### Power On Instance Source: https://my.idcsmart.com/v1/doc Turns on a specified product instance. Requires the product ID. ```APIDOC ## POST /console/v1/remf_finance_common/:id/on ### Description Turns on a specified product instance. ### Method POST ### Endpoint /console/v1/remf_finance_common/:id/on ### Parameters #### Path Parameters - **id** (int) - Required - Product ID ``` -------------------------------- ### Power On Instance Source: https://my.idcsmart.com/v1/doc Turns on a cloud product instance. Requires the instance ID and optionally an operation password for verification. ```APIDOC ## POST /console/v1/mf_cloud/:id/on ### Description Turns on a cloud product instance. ### Method POST ### Endpoint /console/v1/mf_cloud/:id/on ### Parameters #### Path Parameters - **id** (int) - Required - Product ID #### Request Body - **client_operate_password** (string) - Optional - Operation password, required for verification if needed. ``` -------------------------------- ### GET /console/v1/ticket/config Source: https://my.idcsmart.com/v1/doc Get ticket notification settings. Retrieves the configuration for ticket notifications. ```APIDOC ## GET /console/v1/ticket/config ### Description Get ticket notification settings. Retrieves the configuration for ticket notifications. ### Method GET ### Endpoint /console/v1/ticket/config ### Response #### Success Response (200) - **ticket_notice_open** (int) - desc:是否开启工单通知 - **ticket_notice_description** (string) - desc:工单通知描述 ``` -------------------------------- ### Get Recommended Product Detail Source: https://my.idcsmart.com/v1/doc Retrieves detailed information for a specific recommended product using its ID. This includes all specifications and supplier details. ```APIDOC ## GET /api/v1/product/recommend/{id} ### Description Retrieves detailed information for a specific recommended product using its ID. This includes all specifications and supplier details. ### Method GET ### Endpoint /api/v1/product/recommend/{id} ### Parameters #### Path Parameters - **id** (int) - Required - The unique identifier for the recommended product. ### Response #### Success Response (200) - **data** (object) - Contains the details of the recommended product. - **id** (int) - The unique identifier for the recommended product. - **upstream_product_id** (int) - The upstream product ID. - **name** (string) - The name of the product. - **supplier_name** (string) - The name of the supplier. - **login_url** (string) - The login URL for the front-end website. - **url** (string) - The API endpoint URL for the supplier. - **pay_type** (string) - The payment type (e.g., 'free', 'onetime', 'recurring_prepayment', 'recurring_postpaid'). - **price** (string) - The minimum price of the product. - **cycle** (string) - The minimum cycle for the product. - **cpu_min** (int) - The minimum CPU cores. - **cpu_max** (int) - The maximum CPU cores. - **memory_min** (int) - The minimum memory in GB. - **memory_max** (int) - The maximum memory in GB. - **disk_min** (int) - The minimum disk space in GB. - **disk_max** (int) - The maximum disk space in GB. - **bandwidth_min** (int) - The minimum bandwidth in Mbps. - **bandwidth_max** (int) - The maximum bandwidth in Mbps. - **flow_min** (int) - The minimum data flow in G. - **flow_max** (int) - The maximum data flow in G. - **description** (string) - A brief description of the product. #### Response Example { "data": { "id": 1, "upstream_product_id": 123, "name": "VPS Basic Plan", "supplier_name": "ExampleHost", "login_url": "https://examplehost.com/login", "url": "https://api.examplehost.com", "pay_type": "onetime", "price": "10.00", "cycle": "monthly", "cpu_min": 1, "cpu_max": 2, "memory_min": 1, "memory_max": 2, "disk_min": 20, "disk_max": 40, "bandwidth_min": 100, "bandwidth_max": 200, "flow_min": 1000, "flow_max": 2000, "description": "A basic VPS plan for small websites." } } ``` -------------------------------- ### GET /console/v1/ticket/type Source: https://my.idcsmart.com/v1/doc Get ticket types. Retrieves a list of available ticket types. ```APIDOC ## GET /console/v1/ticket/type ### Description Get ticket types. Retrieves a list of available ticket types. ### Method GET ### Endpoint /console/v1/ticket/type ### Response #### Success Response (200) - **list** (array) - desc:工单类型列表 - **list[].id** (int) - desc:工单类型ID - **list[].name** (string) - desc:工单类型名称 ``` -------------------------------- ### Create Account Source: https://my.idcsmart.com/v1/doc Initiates the product activation process for a given product ID. ```APIDOC ## POST /createAccount ### Description Initiates the product activation process. ### Method POST ### Endpoint /createAccount ### Parameters #### Query Parameters - **id** (int) - Required - Product ID ### Response #### Success Response (200) - **status** (int) - Status code: 200 for success, 400 for failure - **msg** (string) - Information message ``` -------------------------------- ### GET /console/v1/ticket/department Source: https://my.idcsmart.com/v1/doc Get ticket departments. Retrieves a list of departments associated with tickets. ```APIDOC ## GET /console/v1/ticket/department ### Description Get ticket departments. Retrieves a list of departments associated with tickets. ### Method GET ### Endpoint /console/v1/ticket/department ### Response #### Success Response (200) - **list** (array) - desc:工单部门列表 - **list[].id** (int) - desc:工单部门ID - **list[].name** (string) - desc:工单部门名称 ``` -------------------------------- ### provisionFunc Source: https://my.idcsmart.com/v1/doc Executes a function on a sub-module for a given product. Supports operations like power on/off, reboot, and password reset. ```APIDOC ## POST /console/v1/reidcsmart_common/host/:host_id/provision/:func ### Description Executes a specified function on a product's sub-module. ### Method POST ### Endpoint /console/v1/reidcsmart_common/host/:host_id/provision/:func ### Parameters #### Path Parameters - **host_id** (int) - Required - Product ID. - **func** (string) - Required - The function to execute (e.g., 'on', 'off', 'reboot', 'crack_pass'). #### Request Body - **password** (string) - Required if func is 'crack_pass' - The password for the operation. ``` -------------------------------- ### Turn On Instance Source: https://my.idcsmart.com/v1/doc Turns on a specific finance instance. Requires the instance ID. ```APIDOC ## POST /console/v1/remf_finance/:id/on ### Description Turns on a specific finance instance. ### Method POST ### Endpoint /console/v1/remf_finance/:id/on ### Parameters #### Path Parameters - **id** (int) - Required - 产品ID ``` -------------------------------- ### Get All Notice Types Source: https://my.idcsmart.com/v1/doc Retrieves all available notification types. ```APIDOC ## GET /allNoticeType ### Description Retrieves all available notification types. ### Method GET ### Endpoint /allNoticeType ### Response #### Success Response (200) - **[].type** (string) - Notification type identifier - **[].name** (string) - Notification type name ``` -------------------------------- ### Power On Instance Source: https://my.idcsmart.com/v1/doc Turns on a specified cloud instance. Requires an administrator operation password for verification. ```APIDOC ## POST /admin/v1/rewhmcs_cloud/:id/on ### Description Turns on a specified cloud instance. Requires an administrator operation password for verification. ### Method POST ### Endpoint /admin/v1/rewhmcs_cloud/:id/on ### Parameters #### Path Parameters - **id** (int) - Required - Product ID #### Request Body - **admin_operate_password** (string) - Optional - Administrator operation password (required for verification) ``` -------------------------------- ### Get Auth List Source: https://my.idcsmart.com/v1/doc Retrieves a list of all available permissions. ```APIDOC ## GET /admin/v1/auth ### Description Retrieves a list of all system permissions, including nested child permissions and associated widgets. ### Method GET ### Endpoint /admin/v1/auth ### Response #### Success Response (200) - **list** (array) - Description: desc:权限列表 - **list[].id** (int) - Description: desc:权限ID - **list[].title** (string) - Description: desc:权限标题 - **list[].url** (string) - Description: desc:地址 - **list[].order** (int) - Description: desc:排序 - **list[].parent_id** (int) - Description: desc:父级ID - **list[].module** (string) - Description: desc:插件模块路径 - **list[].plugin** (string) - Description: desc:插件标识名 - **list[].child** (array) - Description: desc:权限子集 - **list[].child[].id** (int) - Description: desc:权限ID - **list[].child[].title** (string) - Description: desc:权限标题 - **list[].child[].url** (string) - Description: desc:地址 - **list[].child[].order** (int) - Description: desc:排序 - **list[].child[].parent_id** (int) - Description: desc:父级ID - **list[].child[].module** (string) - Description: desc:插件模块路径 - **list[].child[].plugin** (string) - Description: desc:插件标识名 - **list[].child[].child** (array) - Description: desc:权限子集 - **list[].child[].child[].id** (int) - Description: desc:权限ID - **list[].child[].child[].title** (string) - Description: desc:权限标题 - **list[].child[].child[].url** (string) - Description: desc:地址 - **list[].child[].child[].order** (int) - Description: desc:排序 - **list[].child[].child[].parent_id** (int) - Description: desc:父级ID - **list[].child[].child[].module** (string) - Description: desc:插件模块路径 - **list[].child[].child[].plugin** (string) - Description: desc:插件标识名 - **widget** (array) - Description: desc:挂件 - **widget[].id** (string) - Description: desc:挂件标识 - **widget[].title** (string) - Description: desc:挂件标题 ``` -------------------------------- ### Power On Instance Source: https://my.idcsmart.com/v1/doc Turns on a specified cloud instance. Requires the instance ID and optionally an administrator operation password. ```APIDOC ## POST /admin/v1/remf_finance/:id/on ### Description Turns on a specified cloud instance. ### Method POST ### Endpoint /admin/v1/remf_finance/:id/on ### Parameters #### Path Parameters - **id** (int) - Required - Product ID #### Request Body - **admin_operate_password** (string) - Optional - Operation password, to be passed when verification is needed ``` -------------------------------- ### reinstall Source: https://my.idcsmart.com/v1/doc Reinstalls the operating system on an instance. Requires instance ID, OS ID, and port. Optionally allows formatting the data disk. ```APIDOC ## POST /admin/v1/remf_finance/:id/reinstall ### Description Reinstalls the operating system on an instance. ### Method POST ### Endpoint /admin/v1/remf_finance/:id/reinstall ### Parameters #### Path Parameters - **id** (int) - Required - Product ID #### Request Body - **os** (int) - Required - The operating system ID to reinstall - **port** (int) - Required - Port - **admin_operate_password** (string) - Optional - Operation password, pass when verification is needed - **format_data_disk** (int) - Optional - Whether to format the data disk (0=no, 1=yes), defaults to 0 ``` -------------------------------- ### Get Notice Type Name Source: https://my.idcsmart.com/v1/doc Retrieves the name of a notification type. ```APIDOC ## GET /getNoticeTypeName ### Description Retrieves the name of a notification type. ### Method GET ### Endpoint /getNoticeTypeName ### Response #### Success Response (200) - **type** (string) - Notification type identifier - **-** (string) - Placeholder for response value ``` -------------------------------- ### Get Admin Details Source: https://my.idcsmart.com/v1/doc Retrieves details for a specific administrator by their ID. ```APIDOC ## GET /indexAdmin ### Description Retrieves details for a specific administrator by their ID. ### Method GET ### Endpoint /indexAdmin ### Parameters #### Query Parameters - **id** (int) - Required - Administrator ID ``` -------------------------------- ### Batch Operate Instances Source: https://my.idcsmart.com/v1/doc Performs batch operations (power on, power off, reboot) on multiple product instances. Requires a list of product IDs and the action to perform. ```APIDOC ## POST /console/v1/remf_finance_common/batch_operate ### Description Performs batch operations on multiple product instances. ### Method POST ### Endpoint /console/v1/remf_finance_common/batch_operate ### Parameters #### Request Body - **id** (array) - Required - List of product IDs - **action** (string) - Required - Action to perform (on=power on, off=power off, reboot=reboot) ``` -------------------------------- ### Get Module Source: https://my.idcsmart.com/v1/doc Retrieves the type of module associated with the current product. ```APIDOC ## GET /getModule ### Description Retrieves the type of module associated with the current product. No parameters are needed after instantiation. ### Method GET ### Endpoint /getModule ### Parameters #### Query Parameters - **param.server_id** (int) - Interface ID (default: Product model interface ID) - **param.product_id** (int) - Product ID (default: Product model product ID) ### Response #### Success Response (200) - **-** (string) - Returns a string representing the module type ``` -------------------------------- ### Power On Instance Source: https://my.idcsmart.com/v1/doc Turns on a specified cloud instance. Requires the instance ID and optionally an operation password for verification. ```APIDOC ## POST /console/v1/remf_cloud/:id/on ### Description Turns on a specified cloud instance. ### Method POST ### Endpoint /console/v1/remf_cloud/:id/on ### Parameters #### Path Parameters - **id** (int) - Required - Product ID #### Request Body - **client_operate_password** (string) - Optional - Operation password, pass if verification is required ``` -------------------------------- ### Create Backup Source: https://my.idcsmart.com/v1/doc Creates a new backup for a specified product and disk ID. ```APIDOC ## POST /console/v1/remf_cloud/:id/backup ### Description Creates a new backup for a specified product and disk ID. ### Method POST ### Endpoint /console/v1/remf_cloud/:id/backup ### Parameters #### Path Parameters - **id** (int) - Required - Product ID #### Request Body - **name** (int) - Required - Backup name - **disk_id** (int) - Required - Disk ID ``` -------------------------------- ### Batch Operate Instances Source: https://my.idcsmart.com/v1/doc Performs batch operations (power on, power off, reboot, force off, force reboot) on multiple cloud product instances. Requires a list of instance IDs, the action to perform, and optionally an operation password. ```APIDOC ## POST /console/v1/mf_cloud/batch_operate ### Description Performs batch operations on multiple cloud product instances. ### Method POST ### Endpoint /console/v1/mf_cloud/batch_operate ### Parameters #### Request Body - **id** (array) - Required - Product IDs - **action** (string) - Required - Action to perform (on, off, reboot, hard_off, hard_reboot) - **client_operate_password** (string) - Optional - Operation password, required for verification if needed. ``` -------------------------------- ### GET /admin/v1/ticket_internal/department Source: https://my.idcsmart.com/v1/doc Retrieves a list of departments configured for internal ticketing. ```APIDOC ## GET /admin/v1/ticket_internal/department ### Description Retrieves a list of departments configured for internal ticketing. ### Method GET ### Endpoint /admin/v1/ticket_internal/department ### Response #### Success Response (200) - **list** (array) - A list of ticket departments. - **list[].admin_role_id** (int) - The ID of the department. - **list[].name** (string) - The name of the department. ``` -------------------------------- ### Create Snapshot Source: https://my.idcsmart.com/v1/doc Creates a new snapshot for a specified product and disk ID. ```APIDOC ## POST /console/v1/remf_cloud/:id/snapshot ### Description Creates a new snapshot for a specified product and disk ID. ### Method POST ### Endpoint /console/v1/remf_cloud/:id/snapshot ### Parameters #### Path Parameters - **id** (int) - Required - Product ID #### Request Body - **name** (int) - Required - Snapshot name - **disk_id** (int) - Required - Disk ID ``` -------------------------------- ### Get Admin Role Source: https://my.idcsmart.com/v1/doc Retrieves details for a specific admin role by its ID. ```APIDOC ## GET /indexAdminRole ### Description Retrieves details for a specific admin role by its ID. ### Method GET ### Endpoint /indexAdminRole ### Parameters #### Query Parameters - **id** (int) - Required - The ID of the admin role to retrieve. ``` -------------------------------- ### createAccount Source: https://my.idcsmart.com/v1/doc Creates a new account for a product. Requires HostModel data. ```APIDOC ## createAccount ### Description Creates a new account for a product. Requires HostModel data. ### Method POST ### Endpoint /createAccount ### Parameters #### Request Body - **HostModel** (HostModel) - Required - Product model. ### Response #### Success Response (200) - **status** (int) - Status code (200=success, 400=failure). - **msg** (string) - Information message. ``` -------------------------------- ### Get Product List Source: https://my.idcsmart.com/v1/doc Retrieves a list of products with filtering and sorting options. ```APIDOC ## GET /product/list ### Description Retrieves a list of products based on keywords, group ID, and pagination. Supports sorting by various fields. ### Method GET ### Endpoint /product/list ### Parameters #### Query Parameters - **param.keywords** (string) - Optional - Keywords for searching product ID, name, or description. - **param.product_group_id** (int) - Optional - Filter by product group ID. - **param.page** (int) - Optional - Page number for pagination. - **param.limit** (int) - Optional - Number of items per page. - **param.orderby** (string) - Optional - Field to sort by (e.g., 'id', 'name', 'description'). - **param.sort** (string) - Optional - Sort order ('asc' or 'desc'). - **param.exclusive** (bool) - Optional - Whether to return only exclusive products. ### Response #### Success Response (200) - **list** (array) - A list of product objects. - **info** (object) - Pagination information. ``` -------------------------------- ### Reinstall System Source: https://my.idcsmart.com/v1/doc Reinstalls the operating system for a specified product instance. Requires product ID, OS ID, and OS group. An optional verification code can be provided. ```APIDOC ## POST /console/v1/remf_finance_common/:id/reinstall ### Description Reinstalls the operating system for a specified product instance. ### Method POST ### Endpoint /console/v1/remf_finance_common/:id/reinstall ### Parameters #### Path Parameters - **id** (int) - Required - Product ID #### Request Body - **os** (int) - Required - The OS ID for the system reinstallation - **os_group** (string) - Required - The operating system group - **code** (string) - Optional - Secondary verification code (if not provided, API will not perform verification) ``` -------------------------------- ### Get Admin Menu Source: https://my.idcsmart.com/v1/doc Retrieves the navigation menu for the backend administration interface. ```APIDOC ## GET /admin/v1/menu ### Description Retrieves the navigation menu structure for the backend administration interface. ### Method GET ### Endpoint /admin/v1/menu ### Response #### Success Response (200) - **menu** (array) - Description: desc:菜单 - **menu[].id** (int) - Description: desc:菜单ID - **menu[].name** (string) - Description: desc:名称 ```