DescribeContactGroups - API参考| 阿里云

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	DescribeContactGroups	系统规定参数。取值：DescribeContactGroups。
ContactGroupName	String	否	TestGroup	告警联系人组名称。
Page	Long	是	1	查询页数。
Size	Long	是	20	每页展示的联系人组数。
IsDetail	Boolean	否	true	返回的联系人分组信息中是否包含所有联系人。 `fasle`（默认）：不返回所有联系人。 `true`：返回所有联系人。

返回数据


名称	类型	示例值	描述
RequestId	String	4D6C358A-A58B-4F4B-94CE-F5AAF023****	请求ID。
PageBean	Object		分页对象。
Total	Long	1	查询到的联系人组总数。
Page	Long	1	查询的页数。
Size	Long	20	每页的联系人组数。
AlertContactGroups	Array of contactGroups		告警联系人组列表。
ContactGroupId	Float	123	告警联系人组ID。
ContactGroupName	String	TestGroup	告警联系人组名称。
Contacts	Array of contacts		联系人信息。IsDetail设置为`false`时不显示Contacts。
ContactId	Float	456	联系人ID。
ContactName	String	John Doe	联系人姓名。
Phone	String	1381111****	联系人手机号码。
Email	String	someone@example.com	联系人邮箱地址。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeContactGroups
&ContactGroupName=TestGroup
&Page=1
&Size=20
&IsDetail=true
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeContactGroupsResponse>
    <RequestId>4D6C358A-A58B-4F4B-94CE-F5AAF023****</RequestId>
    <PageBean>
        <Total>1</Total>
        <Page>1</Page>
        <Size>20</Size>
        <AlertContactGroups>
            <ContactGroupId>123</ContactGroupId>
            <ContactGroupName>TestGroup</ContactGroupName>
            <Contacts>
                <ContactId>456</ContactId>
                <ContactName>John Doe</ContactName>
                <Phone>1381111****</Phone>
                <Email>someone@example.com</Email>
            </Contacts>
        </AlertContactGroups>
    </PageBean>
</DescribeContactGroupsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "4D6C358A-A58B-4F4B-94CE-F5AAF023****",
  "PageBean" : {
    "Total" : 1,
    "Page" : 1,
    "Size" : 20,
    "AlertContactGroups" : [ {
      "ContactGroupId" : 123,
      "ContactGroupName" : "TestGroup",
      "Contacts" : [ {
        "ContactId" : 456,
        "ContactName" : "John Doe",
        "Phone" : "1381111****",
        "Email" : "someone@example.com"
      } ]
    } ]
  }
}