调用ListNamespaces获取命名空间列表-分布式任务调度-阿里云

获取命名空间列表。

接口说明

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

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

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
edas:ReadSchedulerxNamespaceQuery	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。	cn-hangzhou
NamespaceName	string	否	命名空间名称。	schedulerx-dev
Namespace	string	否	命名空间 UID	adcfc35d-e2fe-4fe9-bbaa-20e90ffc****

返回参数

名称	类型	描述	示例值
	object
Code	integer	接口状态码。	200
Message	string	附加信息。	message
RequestId	string	请求唯一 ID。	71BCC0E3-64B2-4B63-A870-AFB64EBCB58C
Success	boolean	调用接口是否成功。取值如下： true：成功。 false：失败。	true
Data	object	命名空间列表信息。
Namespaces	array<object>	命名空间列表与详情。
Namespace	object
Name	string	命名空间名称。	doc
Description	string	命名空间描述。	test
UId	string	命名空间 ID。	1a72ecb1-b4cc-400a-a71b-20cdec9b****

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Message": "message",
  "RequestId": "71BCC0E3-64B2-4B63-A870-AFB64EBCB58C",
  "Success": true,
  "Data": {
    "Namespaces": [
      {
        "Name": "doc",
        "Description": "test",
        "UId": "1a72ecb1-b4cc-400a-a71b-20cdec9b****"
      }
    ]
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-10-17	OpenAPI 返回结构发生变更	查看变更详情
2023-03-30	API 内部配置变更，不影响调用	查看变更详情
2023-03-01	OpenAPI 入参发生变更	查看变更详情
2022-12-26	API 内部配置变更，不影响调用	查看变更详情

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.ListNamespacesRequest;
import com.aliyuncs.schedulerx2.model.v20190430.ListNamespacesResponse;
import com.aliyuncs.schedulerx2.model.v20190430.ListNamespacesResponse.Data.Namespace;

public class TestListNamespaces {

    public static void main(String[] args) {
        //OpenAPI 的接入点，具体查看支持地域列表以及购买机器地域填写。
        String regionId = "cn-test";
        //鉴权使用的 AccessKey ID，由阿里云官网控制台获取。
        String accessKeyId = "XXXXXXXX";
        //鉴权使用的 AccessKey Secret，由阿里云官网控制台获取。
        String accessKeySecret = "XXXXXXXX";
        //产品名称。
        String productName ="schedulerx2";
        //对照支持地域列表选择 Domain 填写。
        String domain ="schedulerx.aliyuncs.com";
        //构建 OpenAPI 客户端。
        DefaultProfile.addEndpoint(regionId, productName, domain);
        DefaultProfile defaultProfile = DefaultProfile.getProfile(regionId, accessKeyId, accessKeySecret);
        DefaultAcsClient client = new DefaultAcsClient(defaultProfile);
        
        ListNamespacesRequest request = new ListNamespacesRequest();
        ListNamespacesResponse response;
        try {
            response = client.getAcsResponse(request);
            if (!response.getSuccess()) {
                System.out.println(response.getMessage());
            } else {
                List<Namespace> namespaces = response.getData().getNamespaces();
                for (Namespace namespace : namespaces) {
                    System.out.println("namespace uid=" + namespace.getUId());
                }
            }
        } catch (ServerException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        } catch (ClientException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }
    }
    
}