文档

ListGroups - 获取应用分组列表

更新时间:
一键部署

获取应用列表。

接口说明

在调用该接口前,需要在POM文件添加以下依赖:

<dependency>
    <groupId>com.aliyun</groupId>
    <artifactId>aliyun-java-sdk-schedulerx2</artifactId>
    <version>1.0.5</version>
</dependency>

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
Namespacestring

命名空间,在控制台的命名空间页面中获取。

1a72ecb1-b4cc-400a-a71b-20cdec9b****
NamespaceSourcestring

特殊第三方才需要填写。

schedulerx
RegionIdstring

地域ID。

cn-hangzhou
AppGroupNamestring

应用分组名称。

k8s-test

返回参数

名称类型描述示例值
object
Codeinteger

接口状态码。

200
Messagestring

附加信息。

message
RequestIdstring

请求唯一ID。

71BCC0E3-64B2-4B63-A870-AFB64EBCB58A
Successboolean

调用接口是否成功。取值如下:

  • true:成功

  • false:失败

true
Dataobject

应用列表信息。

AppGroupsarray

应用列表和应用详情。

object
AppGroupIdlong

应用分组ID

1
AppNamestring

应用名称。

DocTest
AppKeystring

应用Key。

a3G77O6NZxq/lyo1NC****==
Descriptionstring

应用描述。

Test
GroupIdstring

应用ID。

DocTest.Group

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Message": "message",
  "RequestId": "71BCC0E3-64B2-4B63-A870-AFB64EBCB58A",
  "Success": true,
  "Data": {
    "AppGroups": [
      {
        "AppGroupId": 1,
        "AppName": "DocTest",
        "AppKey": "a3G77O6NZxq/lyo1NC****==",
        "Description": "Test",
        "GroupId": "DocTest.Group"
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

Demo

package com.alibaba.schedulerx.pop;

import java.util.List;

import com.aliyuncs.DefaultAcsClient;
import com.aliyuncs.exceptions.ClientException;
import com.aliyuncs.exceptions.ServerException;
import com.aliyuncs.profile.DefaultProfile;
import com.aliyuncs.schedulerx2.model.v20190430.ListGroupsRequest;
import com.aliyuncs.schedulerx2.model.v20190430.ListGroupsResponse;
import com.aliyuncs.schedulerx2.model.v20190430.ListGroupsResponse.Data.AppGroup;

public class TestListGroups {

    public static void main(String[] args) {
        //OpenAPI的接入点,具体查看支持地域列表以及购买机器地域填写。
        String regionId = "cn-hangzhou";
        //鉴权使用的AccessKey ID,由阿里云官网控制台获取。
        String accessKeyId = "XXXXXXXX";
        //鉴权使用的AccessKey Secret,由阿里云官网控制台获取。
        String accessKeySecret = "XXXXXXXX";
        //产品名称。
        String productName ="schedulerx2";
        //对照支持地域列表选择Domain填写 
        String domain ="schedulerx.cn-hangzhou.aliyuncs.com";
        //构建OpenAPI客户端。
        DefaultProfile.addEndpoint(regionId, productName, domain);
        DefaultProfile defaultProfile = DefaultProfile.getProfile(regionId, accessKeyId, accessKeySecret);
        DefaultAcsClient client = new DefaultAcsClient(defaultProfile);
        
        ListGroupsRequest request = new ListGroupsRequest();
        //命名空间ID。
        request.setNamespace("433d8b23-06e9-408c-aaaa-90d4d1b9****");
        ListGroupsResponse response;
        try {
            response = client.getAcsResponse(request);
            if (!response.getSuccess()) {
                System.out.println(response.getMessage());
            } else {
                List<AppGroup> appGroups = response.getData().getAppGroups();
                for (AppGroup appGroup : appGroups) {
                    System.out.println("groupId=" + appGroup.getGroupId() + ", appKey=" + appGroup.getAppKey());
                }
            }
        } catch (ServerException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        } catch (ClientException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }
    }
    
}
  • 本页导读 (1)