DescribeDiscoveredResource

更新时间:
复制 MD 格式

Queries the configuration details of a specified resource.

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

config:DescribeDiscoveredResource

get

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

ResourceId

string

Yes

The resource ID.

adaf.zhilon****

ResourceType

string

Yes

The resource type.

Note

You can call the GetSupportedResourceTypes operation to query the resource types that are supported by Cloud Config. For more information, see GetSupportedResourceTypes.

ACS::CDN::Domain

Region

string

No

The region ID.

cn-hangzhou

MultiAccount

boolean

No

This parameter is scheduled to be deprecated. We recommend that you use the API operations of account groups to replace this parameter. For more information, see What is an account group?.

true

MemberId

integer

No

This parameter is scheduled to be deprecated. We recommend that you use the API operations of account groups to replace this parameter. For more information, see What is an account group?.

123456789

Response elements

Parameter

Type

Description

Example

object

The response object.

DiscoveredResourceDetail

object

The details of the resource.

AccountId

integer

The ID of the Alibaba Cloud account.

987654321

AvailabilityZone

string

The zone of the resource.

cn-hangzhou-h

Configuration

string

The configuration of the resource.

{\"Description\":\"\",\"SslProtocol\":\"off\",\"DomainName\":\"adaf.zhilong****\",\"GmtModified\":\"2019-04-10T03:11Z\",\"CdnType\":\"web\",\"GmtCreated\":\"2016-03-03T01:31:35Z\",\"Cname\":\"adaf.zhilong.me.w.kun****.com\",\"Sources\":{\"Source\":[{\"Type\":\"oss\",\"Content\":\"test2-mh.oss-cn-hangzhou.aliyuncs.com\",\"Priority\":\"20\",\"Port\":80,\"Weight\":\"10\"}]},\"DomainStatus\":\"offline\",\"Sandbox\":\"\"}

Region

string

The region ID.

cn-hangzhou

ResourceCreationTime

integer

The timestamp when the resource was created.

1456968695000

ResourceDeleted

integer

Indicates whether the resource was deleted. Valid values:

  • 1: The resource is not deleted.

  • 0: The resource is deleted.

1

ResourceId

string

The resource ID.

adaf.zhilon****

ResourceName

string

The resource name.

test-resource-name

ResourceStatus

string

The status of the resource. This parameter can be empty. For example:

  • If the resource type is ACS::ECS::Instance, the value can be Running or Stopped.

  • If the resource type is ACS::OSS::Bucket, this parameter is empty.

  • If the resource type is ACS::CDN::Domain, the value can be online or offline.

offline

ResourceType

string

The resource type.

ACS::CDN::Domain

Tags

string

The tags of the resource.

{\"\"hc\"\":[\"\"value2\"\"]}

RequestId

string

The request ID.

E4D71ACE-6B0A-46E0-8352-56952378CC7F

Examples

Success response

JSON format

{
  "DiscoveredResourceDetail": {
    "AccountId": 987654321,
    "AvailabilityZone": "cn-hangzhou-h",
    "Configuration": "{\\\"Description\\\":\\\"\\\",\\\"SslProtocol\\\":\\\"off\\\",\\\"DomainName\\\":\\\"adaf.zhilong****\\\",\\\"GmtModified\\\":\\\"2019-04-10T03:11Z\\\",\\\"CdnType\\\":\\\"web\\\",\\\"GmtCreated\\\":\\\"2016-03-03T01:31:35Z\\\",\\\"Cname\\\":\\\"adaf.zhilong.me.w.kun****.com\\\",\\\"Sources\\\":{\\\"Source\\\":[{\\\"Type\\\":\\\"oss\\\",\\\"Content\\\":\\\"test2-mh.oss-cn-hangzhou.aliyuncs.com\\\",\\\"Priority\\\":\\\"20\\\",\\\"Port\\\":80,\\\"Weight\\\":\\\"10\\\"}]},\\\"DomainStatus\\\":\\\"offline\\\",\\\"Sandbox\\\":\\\"\\\"}",
    "Region": "cn-hangzhou",
    "ResourceCreationTime": 1456968695000,
    "ResourceDeleted": 1,
    "ResourceId": "adaf.zhilon****",
    "ResourceName": "test-resource-name",
    "ResourceStatus": "offline",
    "ResourceType": "ACS::CDN::Domain",
    "Tags": "{\\\"\\\"hc\\\"\\\":[\\\"\\\"value2\\\"\\\"]}"
  },
  "RequestId": "E4D71ACE-6B0A-46E0-8352-56952378CC7F"
}

Error codes

HTTP status code

Error code

Error message

Description

400 NoPermission You are not authorized to perform this operation. You are not authorized to perform this operation.
400 MemberNotBelongToMaster The specified member does not belong to your organization.
404 AccountNotExisted Your account does not exist.
503 ServiceUnavailable The request has failed due to a temporary failure of the server. The request has failed due to a temporary failure of the server.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.