更新时间:2024-09-12 GMT+08:00
分享

查询消息列表

功能介绍

查询审核中心的通知消息列表。与申请不同,通知类消息,无法驳回,仅能在指定的时间范围内作出处理。

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/service/messages

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参见项目ID和账号ID

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

查询起始坐标, 即跳过前X条数据。仅支持0或limit的整数倍,不满足则向下取整。

limit

Integer

查询条数限制。

api_name

String

API名称。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token,使用Token认证时必选。通过调用IAM服务的“获取用户Token”接口获取响应消息头中X-Subject-Token的值。

workspace

String

工作空间ID,获取方法请参见实例ID和工作空间ID

Dlm-Type

String

数据服务的版本类型,指定SHARED共享版或EXCLUSIVE专享版。

Content-Type

String

消息体的类型(格式),有Body体的情况下必选,没有Body体无需填写。如果请求消息体中含有中文字符,则需要通过charset=utf8指定中文字符集,例如取值为:application/json;charset=utf8。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

total

Integer

符合条件的申请总数。

records

Array of RecordForApplyDetail objects

本次返回的申请列表。

表5 RecordForApplyDetail

参数

参数类型

描述

id

String

申请编号。

api_apply_status

String

申请状态。

枚举值:

  • STATUS_TYPE_PENDING_APPROVAL:待审核

  • STATUS_TYPE_REJECTED:已驳回

  • STATUS_TYPE_PENDING_CHECK:待确认

  • STATUS_TYPE_PENDING_EXECUTE:待执行

  • STATUS_TYPE_SYNCHRONOUS_EXECUTE:同步执行

  • STATUS_TYPE_FORCED_CANCEL:强制取消

  • STATUS_TYPE_PASSED:已通过

api_apply_type

String

申请类型。

枚举值:

  • APPLY_TYPE_PUBLISH:发布API

  • APPLY_TYPE_AUTHORIZE:API主动授权

  • APPLY_TYPE_APPLY:审核API

  • APPLY_TYPE_RENEW:申请续约API

  • APPLY_TYPE_STOP:申请停用API

  • APPLY_TYPE_RECOVER:申请恢复API

  • APPLY_TYPE_API_CANCEL_AUTHORIZE:API取消授权

  • APPLY_TYPE_APP_CANCEL_AUTHORIZE:APP取消授权

  • APPLY_TYPE_OFFLINE:申请下线

api_id

String

API编号。

api_name

String

API名称。

api_using_time

Long

使用截止时间。

app_id

String

APP编号。

app_name

String

APP名称。

apply_time

Long

申请时间。

approval_time

Long

授权时间。

approver_name

String

审核人名称。

comment

String

审核评论。

user_name

String

申请人姓名。

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

查询审核中心的通知消息列表。

/v1/0833a5737480d53b2f250010d01a7b88/service/messages

响应示例

状态码: 200

查询结果成功,符合条件的消息总数。

{
  "total" : 1,
  "records" : [ {
    "id" : "a1c93c3cb17d9747fc41df0377b6fe0f",
    "api_apply_status" : "STATUS_TYPE_PASSED",
    "api_apply_type" : "APPLY_TYPE_APPLY",
    "api_id" : "47046fe7830c1be77cb0dc23bd86afa5",
    "api_name" : "api_demo",
    "api_using_time" : 1580452617000,
    "app_id" : "908489209a320df61607355c57c82882",
    "app_name" : "app_demo",
    "apply_time" : 1578875421000,
    "approval_time" : 1578897421000,
    "approver_name" : "李四",
    "comment" : "通过",
    "user_name" : "张三"
  } ]
}

SDK代码示例

SDK代码示例如下。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.dataartsstudio.v1.region.DataArtsStudioRegion;
import com.huaweicloud.sdk.dataartsstudio.v1.*;
import com.huaweicloud.sdk.dataartsstudio.v1.model.*;


public class ListMessageSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        DataArtsStudioClient client = DataArtsStudioClient.newBuilder()
                .withCredential(auth)
                .withRegion(DataArtsStudioRegion.valueOf("<YOUR REGION>"))
                .build();
        ListMessageRequest request = new ListMessageRequest();
        try {
            ListMessageResponse response = client.listMessage(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdataartsstudio.v1.region.dataartsstudio_region import DataArtsStudioRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdataartsstudio.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = DataArtsStudioClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DataArtsStudioRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListMessageRequest()
        response = client.list_message(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dataartsstudio "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := dataartsstudio.NewDataArtsStudioClient(
        dataartsstudio.DataArtsStudioClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListMessageRequest{}
	response, err := client.ListMessage(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

查询结果成功,符合条件的消息总数。

400

BadRequest。

相关文档