描述
根据传入参数获取所有分组列表。
请求参数
名称 | 类型 | 是否必须 | 描述 |
Action | String | 是 | 操作接口名,系统规定参数,取值:DescribeDomainGroups |
PageNumber | Long | 否 | 当前页数,起始值为1,默认为1 |
PageSize | Long | 否 | 分页查询时设置的每页行数,最大值100,默认为20 |
KeyWord | String | 否 | 组名关键字,按照”%KeyWord%”模式搜索,不区分大小写 |
名称 | 类型 | 描述 |
RequestId | String | 唯一请求识别码 |
TotalCount | Long | 域名分组数量 |
PageNumber | Long | 当前页码 |
PageSize | Long | 本次查询获取的域名分组数量 |
DomainGroups | DomainGroupType | 域名分组结构列表 |
版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。
您描述的是阿里云DNS(Alibaba Cloud DNS)服务中查询域名分组列表的API接口——DescribeDomainGroups
。这个接口允许用户根据指定的参数获取其在阿里云DNS服务下所有域名分组的信息。下面是对您提供的信息的一个详细解析和补充说明:
Action (String
, 必须): 接口操作名,固定值为DescribeDomainGroups
,表示请求获取域名分组列表。
PageNumber (Long
, 非必须): 当前页数,起始值为1,默认为1。用于分页查询时指定从哪一页开始显示结果。
PageSize (Long
, 非必须): 分页查询时每页显示的行数,最大值为100,默认为20。用来控制每次请求返回的结果数量。
KeyWord (String
, 非必须): 组名关键字,按照”%KeyWord%”模式进行模糊搜索,不区分大小写。如果提供此参数,将只返回名称中包含该关键字的域名分组。
RequestId (String
): 每次API请求的唯一识别码,用于问题排查。
TotalCount (Long
): 域名分组的总数,即满足条件的分组数量。
PageNumber (Long
): 实际返回结果的当前页码。
PageSize (Long
): 本次查询实际返回的域名分组数量。
DomainGroups (DomainGroupType
List): 域名分组结构列表,包含了每个分组的具体信息,如分组ID、分组名称等。
除了特定于该接口的错误外,还应参考阿里云API通用错误代码表,这些错误代码提供了关于请求失败原因的详细信息,帮助用户诊断问题。
您给出的示例请求URL展示了如何调用此接口:
http://alidns.aliyuncs.com/?Action=DescribeDomainGroups
请注意,实际使用时,特别是通过程序调用,还需要设置AccessKeyId、AccessKeySecret以及签名等认证信息,并且可能需要通过POST方法提交JSON格式的请求体,具体构造方法和要求请参照阿里云官方文档中的API调用指南。
确保在调用任何阿里云API之前,已经熟悉了相关的安全最佳实践,比如使用RAM角色而非直接暴露AccessKey,以及合理设置API调用的权限策略。