클라우드 리소스 보기

조직의 클라우드 리소스에 대한 모든 속성을 볼 수 있습니다. 이를 통해 클라우드 공급자 계정 전반의 모든 리소스를 재고하거나 가장 최근 스캔 중의 모든 리소스의 기록된 상태를 볼 수 있습니다.

모든 리소스 보기

조직의 모든 리소스를 나열하려면 다음 형식으로 /cloud/resources 엔드포인트에 요청을 보냅니다:

curl -X GET \
  'https://api.snyk.io/rest/orgs/YOUR-ORGANIZATION-ID/cloud/resources?version=2022-12-21~beta' \
  -H 'Authorization: token YOUR-API-TOKEN'

API 응답 이해

Snyk은 조직의 모든 리소스에 대한 정보가 포함된 JSON 문서를 반환합니다. 예:

{
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "next": "/rest/orgs/d70c1768-5675-4f44-0000-1234abcd1234/cloud/resources?starting_after=eyJpZCI6IjY5ODA5MjNhLWU0ZTAtNDg3Mi04ZDAwLWRjZDEXAMPLEEXAMPLE&version=2022-04-13~experimental"
  },
  "data": [
    {
      "id": "23b3a46d-cdf7-526c-8888-1abc2abc3abc",
      "type": "resource",
      "attributes": {
        "environment_id": "ef5d85de-fb4f-4c42-1234-000000000000",
        "scan_id": "44f386a6-6ce8-4303-0000-098765432109",
        "created_at": "2022-08-07T05:34:24.272279Z",
        "updated_at": "2022-08-07T05:34:24.272279Z",
        "revision": 1,
        "kind": "cloud",
        "hash": "717cdff4218bf3d6abcdefEXAMPLEEXAMPLEEXAMPLEEXAMPLEEXAMPLEEXAMPLE",
        "platform": "aws",
        "namespace": "us-east-1",
        "resource_type": "aws_s3_bucket",
        "resource_id": "example-bucket",
        "native_id": "arn:aws:s3:::example-bucket",
        "name": "example-bucket",
        "location": "us-east-1",
        "state": {
          "id": "example-bucket",
          "acl": "private",
          "arn": "arn:aws:s3:::example-bucket"
          <길이 때문에 생략>
        },
        "tags": {}
      },
      "relationships": {
        "environment": {
          "data": {
            "id": "ef5d85de-fb4f-4c42-1234-000000000000",
            "type": "environment"
          },
          "links": {
            "related": "/orgs/d70c1768-5675-4f44-0000-1234abcd1234/cloud/environments?id=ef5d85de-fb4f-4c42-1234-000000000000&version=2022-12-21~beta"
          }
        },
        "organization": {
          "data": {
            "id": "d70c1768-5675-4f44-0000-1234abcd1234",
            "type": "organization"
          },
          "links": {
            "related": "/orgs/d70c1768-5675-4f44-0000-1234abcd1234?version=2022-12-21~beta"
          }
        },
        "scan": {
          "data": {
            "id": "a7fa2167-58a8-4ac5-9999-0987dcba6543",
            "type": "scan"
          },
          "links": {
            "related": "/orgs/d70c1768-5675-4f44-0000-1234abcd1234/cloud/scans?id=a7fa2167-58a8-4ac5-9999-0987dcba6543&version=2022-12-21~beta"
          }
        }
      }
    }
    <길이 때문에 생략>
  ]
}

다음 표에는 API 응답의 주요 속성이 나열되어 있습니다:

속성	정의
data.id	리소스 ID
data.attributes.environment_id	리소스를 포함하는 환경의 ID
data.attributes.scan_id	이 리소스가 처음 감지된 스캔의 ID
data.attributes.resource_type	리소스 유형
data.attributes.native_id	클라우드 공급자의 고유 리소스 식별자; AWS의 경우 ARN(Amazon Resource Name)
data.attributes.state	가장 최근 스캔 시점의 리소스 속성

리소스 목록 필터링

쿼리 매개변수를 사용하여 리소스 목록을 필터링할 수 있습니다.

예를 들어, 단일 환경의 리소스만 반환하려면 URL에 environment_id=YOUR-ENVIRONMENT-ID를 추가하십시오:

curl -X GET \
  'https://api.snyk.io/rest/orgs/YOUR-ORGANIZATION-ID/cloud/resources?environment_id=YOUR-ENVIRONMENT-ID&version=2022-12-21~beta' \
  -H 'Authorization: token YOUR-API-TOKEN'

일부 매개변수는 여러 값을 지정할 수 있습니다. Amazon Web Services (AWS) 리전 us-east-1 또는 us-east-2의 리소스를 반환하려면 URL에 location=us-east-1,us-east-2를 추가하십시오:

curl -X GET \
  'https://api.snyk.io/rest/orgs/YOUR-ORGANIZATION-ID/cloud/resources?location=us-east-1,us-east-2&version=2022-12-21~beta' \
  -H 'Authorization: token YOUR-API-TOKEN'

& 기호를 사용하여 쿼리 매개변수를 결합할 수 있습니다. 5개의 AWS S3 버킷만 반환하려면 URL에 resource_type=aws_s3_bucket&limit=5를 추가하십시오:

curl -X GET \
  'https://api.snyk.io/rest/orgs/YOUR-ORGANIZATION-ID/cloud/resources?resource_type=aws_s3_bucket&limit=5&version=2022-12-21~beta' \
  -H 'Authorization: token YOUR-API-TOKEN'

지원되는 매개변수 목록은 리소스 목록 API 문서를 참조하십시오.

단일 리소스에 대한 세부 정보 보기

Snyk API를 통해 단일 리소스에 대한 세부 정보를 보려면 다음 형식으로 요청을 보내십시오.

curl -X GET \
  'https://api.snyk.io/rest/orgs/YOUR-ORGANIZATION-ID/cloud/resources?id=YOUR-RESOURCE-ID&version=2022-12-21~beta' \
  -H 'Authorization: token YOUR-API-TOKEN'

Snyk은 선택한 리소스에 대한 정보가 포함된 JSON 문서를 반환합니다. 정보는 API 응답 이해에 표시된 것과 동일합니다.