调用ListGroups获取应用列表。

说明 在调用该接口前,需要在POM文件添加以下依赖:
<dependency>
      <groupId>com.aliyun</groupId>
      <artifactId>aliyun-java-sdk-schedulerx2</artifactId>
      <version>1.0.5</version>
</dependency>

请求参数

名称 类型 是否必选 示例值 描述
Action String ListGroups

系统规定参数。取值:ListGroups。

Namespace String 1a72ecb1-b4cc-400a-a71b-20cdec9b****

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

RegionId String cn-hangzhou

地域ID。

NamespaceSource String schedulerx

特殊第三方才需要填写。

返回数据

名称 类型 示例值 描述
Code Integer 200

接口状态码。

Data Struct

应用列表信息。

AppGroups Array of AppGroup

应用列表和应用详情。

AppKey String a3G77O6NZxq/lyo1NC****==

应用Key。

AppName String DocTest

应用名称。

Description String Test

应用描述。

GroupId String DocTest.Group

应用ID。

Message String namespace can not find namespace: 1a72ecb1-b4cc-400a-a71b-20cdec9b****, namespaceSource:null

错误信息,仅出错时返回错误信息。

RequestId String 71BCC0E3-64B2-4B63-A870-AFB64EBCB58A

请求唯一ID。

Success Boolean true

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

  • true:成功
  • false:失败

示例

请求示例

http(s)://[Endpoint]/?Action=ListGroups
&Namespace=1a72ecb1-b4cc-400a-a71b-20cdec9b****
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML格式

<ListGroupsResponse>
  <Message>namespace can not find namespace: 1a72ecb1-b4cc-400a-a71b-20cdec9b****, namespaceSource:null</Message>
  <RequestId>71BCC0E3-64B2-4B63-A870-AFB64EBCB58A</RequestId>
  <Data>
        <AppGroups>
              <Description>Test</Description>
              <AppKey>a3G77O6NZxq/lyo1NC****==</AppKey>
              <GroupId>DocTest.Group</GroupId>
              <AppName>DocTest</AppName>
        </AppGroups>
  </Data>
  <Code>200</Code>
  <Success>true</Success>
</ListGroupsResponse>

JSON格式

{
    "Message": "namespace can not find namespace: 1a72ecb1-b4cc-400a-a71b-20cdec9b****, namespaceSource:null",
    "RequestId": "71BCC0E3-64B2-4B63-A870-AFB64EBCB58A",
    "Data": {
        "AppGroups": {
            "Description": "Test",
            "AppKey": "a3G77O6NZxq/lyo1NC****==",
            "GroupId": "DocTest.Group",
            "AppName": "DocTest"
        }
    },
    "Code": 200,
    "Success": true
}

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();
        }
    }
    
}