客户调用火山引擎的OpenAPI接口,是通过向指定服务地址发送请求,并需满足火山引擎签名信息和具体接口的业务信息来完成的。火山引擎的OpenAPI的请求结构组织如下,以CreateMigrationJob一条未编码的URL请求示例:
GET /?Action=CreateMigrationJob&Version=2020-04-01&DestinationConfig.DestinationType=ECSInstance&DestinationConfig.Region=cn-beijing&MigrationJobName=VM迁移至ECS&MigrationSourceId=s-iegs1y963vj0******&NetworkConfig.NetworkTransitionMode=PublicNetwork&SyncConfig.SyncType=File&SyncConfig.TriggerLastSync=true HTTP/1.1 Host: open.volcengineapi.com Region: cn-beijing Service: smc
GET
表示请求方法,服务器迁移中心的OpenAPI支持GET请求。
Action=CreateMigrationJob
指定了要调用的API,Version=2020-04-01
是API的版本。
Host
指定了火山引擎服务接入地址(Endpoint)。
Region
和Service
是请求的Region和服务名称,具体请参见公共参数。
HTTP
指定了请求通信协议。
火山引擎的OpenAPI的通用服务接入地址为:open.volcengineapi.com
支持通过 HTTP 或 HTTPS 两种方式进行请求通信,推荐使用安全性更高的 HTTPS 方式发送请求。
请求方法详见各个接口具体的需求。服务器迁移中心的OpenAPI支持GET请求。
注意
火山引擎的OpenAPI请求包含两类参数:公共请求参数和接口请求参数。其中,公共请求参数是每一个接口需要包含的,具体可参见公共参数小节。接口请求参数是各个接口特有的,详见各个接口描述。
请求及返回结果使用UTF-8的字符集进行编码。