更新时间:2024-05-07 GMT+08:00
分享

查询通知管理列表

功能介绍

功能描述:用户可以使用该接口查询通知管理列表。

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/notices

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目id,最大32位,字母和数字组成

最小长度:0

最大长度:32

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

每页记录数,取值0-100

最小值:0

最大值:100

缺省值:10

offset

Integer

记录数偏移量

最小值:0

最大值:2147483647

缺省值:0

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户凭证

Content-Type

String

消息体的类型(格式)

缺省值:application/json

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

lists

Array of TicsApproveLogVo objects

实例集合

total

Long

总记录数

表5 TicsApproveLogVo

参数

参数类型

描述

create_time

String

创建时间

creator_id

String

创建者Id

creator_name

String

创建者名称

domain_alias

String

租户别名

domain_name

String

租户名称

league

TicsLeagueNoticeVo object

空间信息

league_id

String

空间Id

league_name

String

空间名称

partner_id

String

空间参与方Id

partner_status

String

空间参与方状态,JOINED已加入,JOIN_PENDING_APPROVAL待审核,JOIN_REJECTED拒绝加入,QUIT已退出

枚举值:

  • JOINED

  • JOIN_PENDING_APPROVAL

  • JOIN_REJECTED

  • QUIT

partners

Array of TicsLeaguePartnerVo objects

空间合作方信息

update_id

String

更新者Id

update_name

String

更新者名称

update_time

String

更新时间

表6 TicsLeagueNoticeVo

参数

参数类型

描述

bcs_channel_name

String

BCS通道名称

最小长度:0

最大长度:128

bcs_ip

String

BCS浏览器ip

最小长度:0

最大长度:128

bcs_org_name

String

BCS组织名称

最小长度:0

最大长度:128

block_chain_id

String

BCS服务实例ID

最小长度:0

最大长度:64

block_chain_name

String

BCS服务实例名称

最小长度:0

最大长度:128

create_time

Long

创建时间

creator_name

String

创建人名称

最小长度:0

最大长度:128

description

String

描述信息

最小长度:0

最大长度:512

expire_time

Long

过期时间

id

String

空间id

最小长度:0

最大长度:32

name

String

空间名称

最小长度:0

最大长度:128

partners

Long

空间成员数

表7 TicsLeaguePartnerVo

参数

参数类型

描述

id

String

空间合作方Id

partner_domain_alias

String

空间合作方别名

partner_domain_name

String

空间合作方租户名

partner_status

String

空间合作方状态

状态码: 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

请求示例

查询通知管理列表

get /v1/{project_id}/notices?limit=10&offset=0

响应示例

状态码: 200

OK

{
  "total" : 1,
  "lists" : [ {
    "league" : {
      "id" : "ef73b252a0ad4b5db21a12c40a413b2f",
      "name" : "1.14.1升级验证",
      "partners" : 0,
      "creator_name" : "user01",
      "create_time" : 0,
      "expire_time" : 0
    },
    "partners" : [ {
      "id" : "2820810528fc4f1ba7eda2ae2de0a119",
      "partner_domain_name" : "user02",
      "partner_domain_alias" : "tics02",
      "partner_status" : "JOINED"
    }, {
      "id" : "351bbd7f60e54c9d93d1a4e0b1a099bc",
      "partner_domain_name" : "user01",
      "partner_domain_alias" : "space_creator",
      "partner_status" : "JOINED"
    }, {
      "id" : "8e06e2722ef54f67a8b42e9609f3cf04",
      "partner_domain_name" : "user03",
      "partner_domain_alias" : "dayu003",
      "partner_status" : "JOINED"
    } ],
    "league_id" : "ef73b252a0ad4b5db21a12c40a413b2f",
    "league_name" : "1.14.1升级验证",
    "partner_id" : "098593b06a80d2a30f5fc004c28f6da0",
    "domain_name" : "user01",
    "domain_alias" : "space_creator",
    "partner_status" : "JOINED",
    "creator_id" : "098593b08f00d2a34f64c004408b64bc",
    "creator_name" : "user01",
    "create_time" : "2022-10-08T08:00:55.000+00:00",
    "update_time" : "2022-10-08T08:00:55.000+00:00",
    "update_name" : "user01"
  } ]
}

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.tics.v1.region.ticsRegion;
import com.huaweicloud.sdk.tics.v1.*;
import com.huaweicloud.sdk.tics.v1.model.*;


public class ListNoticesSolution {

    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");

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

        ticsClient client = ticsClient.newBuilder()
                .withCredential(auth)
                .withRegion(ticsRegion.valueOf("<YOUR REGION>"))
                .build();
        ListNoticesRequest request = new ListNoticesRequest();
        request.withLimit(<limit>);
        request.withOffset(<offset>);
        try {
            ListNoticesResponse response = client.listNotices(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

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdktics.v1.region.tics_region import ticsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdktics.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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

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

    try:
        request = ListNoticesRequest()
        request.limit = <limit>
        request.offset = <offset>
        response = client.list_notices(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"
    tics "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/tics/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/tics/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/tics/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")

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

    client := tics.NewticsClient(
        tics.ticsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListNoticesRequest{}
	request.Limit = int32(<limit>)
	request.Offset = int32(<offset>)
	response, err := client.ListNotices(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

OK

500

获取节点列表失败

分享:

    相关文档

    相关产品