ListIpamResourceDiscoveries - Virtual Private Cloud - Alibaba Cloud Documentation Center

Retrieves a list of IPAM resource discovery instances.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vpc:ListIpamResourceDiscoveries

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region. You can call the DescribeRegions operation to get the region ID.	cn-hangzhou
ResourceGroupId	string	No	The ID of the resource group to which the resource discovery belongs.	rg-aek2sermdd6****
IpamResourceDiscoveryIds	array	No	The IDs of the resource discovery instances. You can query up to 100 instances at a time.
	string	No	The ID of the resource discovery instance.	ipam-res-disco-jt5f2af2u6nk2z321****
IpamResourceDiscoveryName	string	No	The name of the resource discovery. The name must be 1 to 128 characters in length and cannot start with http:// or https://.	test
Type	string	No	The type of the resource discovery. Note The following types are supported: system: a default resource discovery created by the system. custom: a custom resource discovery created by a user.	system
Tags	array<object>	No	The list of tags.
	object	No	The list of tags.
Key	string	No	The tag key. You can specify up to 20 tag keys. The key cannot be an empty string. A tag key can be up to 64 characters in length. It must start with a letter or a Chinese character and can contain digits, periods (.), underscores (_), and hyphens (-). The key cannot start with `aliyun` or `acs:` and cannot contain `http://` or `https://`.	FinanceDept
Value	string	No	The tag value. You can specify up to 20 tag values. The value can be an empty string. A tag value can be up to 128 characters in length and cannot contain `http://` or `https://`.	FinanceJoshua
NextToken	string	No	The token for the next page of results. Valid values: If NextToken is empty, no more results are available. If a value is returned for NextToken, the value is the token that is used for the next query.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	No	The maximum number of entries to return on each page. Valid values: 1 to 100. Default value: 10.	10
IsShared	boolean	No	Specifies whether the resource discovery is shared.	true

Response elements

Element	Type	Description	Example
	object	The list of returned results.
IpamResourceDiscoveries	array<object>	The list of resource discovery instances.
	object	The list of resource discovery instances.
IpamResourceDiscoveryId	string	The ID of the resource discovery instance.	ipam-res-disco-jt5f2af2u6nk2z321****
IpamResourceDiscoveryName	string	The name of the resource discovery.	test
IpamResourceDiscoveryDescription	string	The description of the resource discovery.	test description
OperatingRegionList	array	The list of operating regions of the resource discovery.
	string	The operating region of the resource discovery.	cn-hangzhou
Type	string	The type of the resource discovery.	system
IpamResourceDiscoveryStatus	string	The status of the resource discovery instance. Valid values: Creating: The instance is being created. Created: The instance is created. Modifying: The instance is being modified. Deleting: The instance is being deleted. Deleted: The instance is deleted.	Created
ResourceGroupId	string	The ID of the resource group to which the resource discovery belongs.	rg-aek2sermdd6****
CreateTime	string	The time when the resource discovery was created.	2022-07-01T02:05:23Z
Tags	array<object>	The list of tags.
	object	The list of tags.
Key	string	The tag key.	FinanceDept
Value	string	The tag value.	FinanceJoshua
RegionId	string	The ID of the region where the resource discovery instance is located.	cn-hangzhou
OwnerId	integer	The Alibaba Cloud account of the owner of the resource discovery instance.	1210123456******
ShareType	string	The sharing status of the resource. If this parameter is empty, the resource discovery is a regular instance. If this parameter is set to Shared, the resource discovery is a shared resource. If this parameter is set to Sharing, the resource discovery is being shared.	Shared
NextToken	string	The token for the next page of results. Valid values: If NextToken is empty, no more results are available. If a value is returned for NextToken, the value is the token that is used for the next query.	FFmyTO70tTpLG6I3FmYAXGKPd****
TotalCount	integer	The total number of entries that match the query conditions.	1
MaxResults	integer	The maximum number of entries returned on each page. Valid values: 1 to 100. Default value: 10.	10
Count	integer	The number of entries returned on the current page.	1
RequestId	string	The request ID.	86137597-443F-5B66-B9B6-8514E0C50B8F

Examples

Success response

JSON format

{
  "IpamResourceDiscoveries": [
    {
      "IpamResourceDiscoveryId": "ipam-res-disco-jt5f2af2u6nk2z321****",
      "IpamResourceDiscoveryName": "test",
      "IpamResourceDiscoveryDescription": "test description",
      "OperatingRegionList": [
        "cn-hangzhou"
      ],
      "Type": "system",
      "IpamResourceDiscoveryStatus": "Created",
      "ResourceGroupId": "rg-aek2sermdd6****",
      "CreateTime": "2022-07-01T02:05:23Z",
      "Tags": [
        {
          "Key": "FinanceDept",
          "Value": "FinanceJoshua"
        }
      ],
      "RegionId": "cn-hangzhou",
      "OwnerId": 0,
      "ShareType": "Shared"
    }
  ],
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "TotalCount": 1,
  "MaxResults": 10,
  "Count": 1,
  "RequestId": "86137597-443F-5B66-B9B6-8514E0C50B8F"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.