文档中心

OpenAPI使用示例

最近更新时间：2024.04.11 14:41:25

首次发布时间：2023.12.01 20:15:46

本文介绍了应用性能监控全链路版（APMPlus）提供的各语言版本的Demo示例，帮助您快速调用OpenAPI。

前提条件

您需要使用签名SDK中的签名方法。各语言的SDK地址，请参见SDK概览。

注意

示例代码强依赖于签名SDK，不能使用通过签名机制构建的Authorization。

示例代码

Java

Python

package main

import (
    "bytes"
    "context"
    "fmt"
    "io"
    "net/http"
    "time"

    volc "github.com/volcengine/volc-sdk-golang/base"
)

const (
    Host        = "https://open.volcengineapi.com"
    ServiceName = "apmplus_openapi"
    Region      = "cn-beijing"
    AK          = "xx"
    SK          = "xx=="
)

func main() {
    // 1. 初始化方法信息
    var (
        action  = "GetAppAlarmRuleList" // 接口名
        version = "2022-10-12"          // 接口版本
        appID   = "123456"              // 应用id
    )
    ctx := context.Background()
    // 2. 构造请求体
    req := buildRequest(ctx, action, version, appID)
    // 3. 发起请求
    cli := &http.Client{Timeout: time.Second * 5}
    resp, err := cli.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    data, _ := io.ReadAll(resp.Body)
    fmt.Println(string(data))
}

// buildRequest
func buildRequest(ctx context.Context, action, version, appID string) *http.Request {
    payload := buildRequestJsonBody()
    body := bytes.NewBuffer([]byte(payload))

    req, _ := http.NewRequest("POST", Host, body)
    q := req.URL.Query()
    q.Add("Action", action)
    q.Add("Version", version)
    req.URL.RawQuery = q.Encode()
    req.Header.Set("x-app-ids", appID)
    req.Header.Set("content-type", "application/json")
    // sign签名
    c := volc.Credentials{
        AccessKeyID:     AK,
        SecretAccessKey: SK,
        Service:         ServiceName,
        Region:          Region,
    }
    req = c.Sign(req)
    return req
}

// buildRequsetBody 当前接口的请求 body，json string 格式
func buildRequestJsonBody() string {
    return `{
        "monitor_types":[
            "crash"
        ],
        "query_key":"测试报警",
        "status":[
        ],
        "page_no":1,
        "page_size":1
    }`
}

注意

依赖的版本信息需满足volc-sdk-java版本≥1.0.133。

package com.example.demo;

import com.volcengine.error.SdkError;
import com.volcengine.helper.Const;
import com.volcengine.model.ApiInfo;
import com.volcengine.model.Credentials;
import com.volcengine.model.ServiceInfo;
import com.volcengine.model.response.RawResponse;
import com.volcengine.service.BaseServiceImpl;
import org.apache.http.NameValuePair;
import org.apache.http.Header;
import org.apache.http.message.BasicHeader;
import org.apache.http.message.BasicNameValuePair;

import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Map;

public class DemoService extends BaseServiceImpl {

    private static final String ServiceName = "apmplus_openapi";
    private static final String Host = "open.volcengineapi.com";
    private static final String Scheme = "https";
    private static final String Path = "/";
    private static final String AK = "xx";
    private static final String SK = "xx==";
    private static final String AppID = "12345";

    public DemoService(ServiceInfo info, Map<String, ApiInfo> apiInfoList) {
        super(info, null, apiInfoList);
    }

    public static void main(String[] args) throws Exception {

        String action = "AnalyseSummary"; // 接口名
        String version = "2022-10-12"; // 版本号

        Map<String, ApiInfo> apiInfoList = buildApiInfo(action, version);

        ServiceInfo serviceInfo = buildServiceInfo();

        DemoService service = new DemoService(serviceInfo, apiInfoList);
        service.setAccessKey(DemoService.AK);
        service.setSecretKey(DemoService.SK);

        RawResponse response = service.json(action, null, buildRequestJsonBody());
        if (response.getCode() != SdkError.SUCCESS.getNumber()) {
            System.out.println("errorNo:" + response.getCode());
            return;
        }
        System.out.println(new String(response.getData(), StandardCharsets.UTF_8));
    }

    /**
     * 当前接口的请求 body，json string 格式
     * {
     * "os":"iOS",
     * "start_time":1658664000,
     * "end_time":1658750543,
     * "compare_start_time":1658577457,
     * "compare_end_time":1658664000,
     * "filters": {
     * "type":"and",
     * "sub_conditions":[
     * {
     * "dimension":"os",
     * "op":"in",
     * "type":"expression",
     * "values":["iOS"]
     * }
     * ]
     * },
     * "order_by":"count"
     * }
     */
    private static String buildRequestJsonBody() {
        return "{"os":"iOS","start_time":1658664000,"end_time":1658750543,"compare_start_time":1658577457,"compare_end_time":1658664000,"filters":{"type":"and","sub_conditions":[{"dimension":"os","op":"in","type":"expression","values":["iOS"]}]},"order_by":"count"}";
    }

    private static ServiceInfo buildServiceInfo() {
        return new ServiceInfo(new HashMap<String, Object>() {
            {
                put(Const.CONNECTION_TIMEOUT, 5000);
                put(Const.SOCKET_TIMEOUT, 5000);
                put(Const.Host, DemoService.Host);
                put(Const.Credentials, new Credentials(Const.REGION_CN_NORTH_1, DemoService.ServiceName));
                put(Const.Scheme, DemoService.Scheme);
            }
        });
    }

    private static Map<String, ApiInfo> buildApiInfo(final String action, final String version) {
        return new HashMap<String, ApiInfo>() {
            {
                put(action, new ApiInfo(
                        new HashMap<String, Object>() {
                            {
                                put(Const.Method, "POST");
                                put(Const.Path, DemoService.Path);
                                put(Const.Header, new ArrayList<Header>() {
                                    {
                                        add(new BasicHeader("x-app-ids", DemoService.AppID));
                                    }
                                });
                                put(Const.Query, new ArrayList<NameValuePair>() {
                                    {
                                        add(new BasicNameValuePair("Action", action));
                                        add(new BasicNameValuePair("Version", version));
                                    }
                                });
                            }
                        }));
            }
        };
    }

}

import json

from volcengine.ApiInfo import ApiInfo
from volcengine.Credentials import Credentials
from volcengine.ServiceInfo import ServiceInfo
from volcengine.base.Service import Service

# https://github.com/volcengine/volc-sdk-python
# pip install --user volcengine
# 请求信息
host = "open.volcengineapi.com"
ak = "xx"
sk = "xx=="
service = "apmplus_openapi"
region = "cn-beijing"
action = "GetAppAlarmRuleList"
version = "2022-10-12"
method = "POST"
params = {}
header = {
    "x-app-ids": "187277",
    "content-type": "application/json"
}
payload = {
    "monitor_types": ["crash"],
    "page_no": 1,
    "page_size": 1,
}

if __name__ == '__main__':
    s = Service(
        ServiceInfo(host, header, Credentials(ak, sk, service, region), 5, 5),
        {
          action: ApiInfo(method, "/", {"Action": action, "Version": version}, {}, {})
        }
    )
    resp = s.json(action, params, json.dumps(payload))
    print(resp)

调用接口时，请修改示例代码为对应接口的Action、AppID、AK、SK、Service、Region。

前提条件

示例代码